Relatórios - Desenvolvedores

Observações

Expert level

O API key deve be sent as um Bearer token no Authorization header do request. Get your API key.

Listar

API endpoint:

GET

https://seo.oktopus.cloud/api/v1/reports

Request example:

curl --location --request GET 'https://seo.oktopus.cloud/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parâmetro

Tipo

Descrição

search

opcional string

Consulta de busca.

search_by

opcional string

Buscar por. Valores possíveis: url for URL. Padrão: url.

website_id

opcional integer

Website ID.

result

opcional string

Resultado. Valores possíveis: good for Bom, decent for Razoável, bad for Ruim.

sort_by

opcional string

Ordenar por. Valores possíveis: id for Data de criação, url for URL, score for Pontuação. Padrão: id.

sort

opcional string

Ordenar. Valores possíveis: desc for Decrescente, asc for Crescente. Padrão: desc.

per_page

opcional integer

Resultados por página. Valores possíveis: 10, 25, 50, 100. Padrão: 10.

Mostrar

API endpoint:

GET

https://seo.oktopus.cloud/api/v1/reports/{id}

Request example:

curl --location --request GET 'https://seo.oktopus.cloud/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Armazenar

API endpoint:

POST

https://seo.oktopus.cloud/api/v1/reports

Request example:

curl --location --request POST 'https://seo.oktopus.cloud/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'

Parâmetro

Tipo

Descrição

url

obrigatório string

URL.

Excluir

API endpoint:

DELETE

https://seo.oktopus.cloud/api/v1/reports/{id}

Request example:

curl --location --request DELETE 'https://seo.oktopus.cloud/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'