Relatórios

Notas
Nível especialista
A chave API deve ser enviada como um token Bearer no cabeçalho Authorization da requisição. Obtenha sua chave API.

A API abrange relatórios, projetos e dados da conta. Não permite executar as ferramentas de SEO.

Disponível em planos com API; caso contrário, o servidor responde 403. Limites: 60 solicitações por minuto, 10 por minuto para criar e atualizar relatórios.

Lista

API endpoint:

GET 
https://itseo.pro/api/v1/reports

Exemplo de solicitação: 

curl --location --request GET 'https://itseo.pro/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
optional string
A consulta de pesquisa.
search_by
optional string
Pesquisar por. Possible values are: url for URL. Padrão: url.
project
optional string
O nome do projeto.
result
optional string
O resultado do relatório. Possible values are: good for Bom, decent for Razoável, bad for Ruim.
sort_by
optional string
Ordenar por. Possible values are: id for Data de criação, generated_at for Data de geração, url for URL, result for Resultado. Padrão: id.
sort
optional string
Sort. Possible values are: desc for Decrescente, asc for Crescente. Padrão: desc.
per_page
optional int
Resultados por página. Possible values are: 10, 25, 50, 100. Padrão: 100.
Mostrar

API endpoint:

GET 
https://itseo.pro/api/v1/reports/{id}

Exemplo de solicitação: 

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

API endpoint:

POST 
https://itseo.pro/api/v1/reports

Exemplo de solicitação: 

curl --location --request POST 'https://itseo.pro/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
required string
A URL da página web.
privacy
optional integer
Privacidade da página do relatório. Possible values are: 0 for Público, 1 for Privado, 2 for Senha. Padrão: 1.
password
optional string
A senha da página do relatório. Funciona apenas quando privacy está definido como 2.
Atualizar

API endpoint:

PUT PATCH 
https://itseo.pro/api/v1/reports/{id}

Exemplo de solicitação: 

curl --location --request PUT 'https://itseo.pro/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
privacy
optional integer
Privacidade da página do relatório. Possible values are: 0 for Público, 1 for Privado, 2 for Senha.
password
optional string
A senha da página do relatório. Funciona apenas quando privacy está definido como 2.
results
optional integer
Atualizar os resultados do relatório. Possible values are: 0 for Não, 1 for Sim. Padrão: 0.
Excluir

API endpoint:

DELETE 
https://itseo.pro/api/v1/reports/{id}

Exemplo de solicitação: 

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