Relatórios

Notas
Expert level
A chave da API deve ser enviada como um token Bearer no cabeçalho de autorização da solicitação. Obtenha sua chave de API.
Listar

Ponto de acesso da API:

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

Exemplo de solicitação: 

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
A consulta de busca.
search_by
opcional string
Buscar por. Os valores possíveis são: url para URL. Padrão: url.
project
opcional string
O nome do projeto.
result
opcional string
The report result. Os valores possíveis são: good para Bom, decent para Razoável, bad para Ruim.
sort_by
opcional string
Ordenar por. Os valores possíveis são: id para Data de criação, generated_at para Data gerada, url para URL, result para Resultado. Padrão: id.
sort
opcional string
Ordenar. Os valores possíveis são: desc para Decrescente, asc para Crescente. Padrão: desc.
per_page
opcional integer
Resultados por página. Os valores possíveis são: 10, 25, 50, 100. Padrão: 10.
Mostrar

Ponto de acesso da API:

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

Exemplo de solicitação: 

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

Ponto de acesso da API:

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

Exemplo de solicitação: 

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
The webpage's URL.
privacy
opcional integer
Report page privacy. Os valores possíveis são: 0 para Público, 1 para Privado, 2 para Senha. Padrão: 0.
password
opcional string
The password for the report page. Only works with privacy set to 2.
Atualizar

Ponto de acesso da API:

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

Exemplo de solicitação: 

curl --location --request PUT 'https://seo.oktopus.cloud/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
privacy
opcional integer
Report page privacy. Os valores possíveis são: 0 para Público, 1 para Privado, 2 para Senha.
password
opcional string
The password for the report page. Only works with privacy set to 2.
results
opcional integer
Update the report results. Os valores possíveis são: 0 para Não, 1 para Sim. Padrão: 0.
Excluir

Ponto de acesso da API:

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

Exemplo de solicitação: 

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