Relatórios

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

Endpoint da API:

GET 
https://seo.tb.digital/api/v1/reports

Exemplo de requisição: 

curl --location --request GET 'https://seo.tb.digital/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
opcional string
Consulta de pesquisa.
search_by
opcional string
Buscar por. Os valores possíveis são: url para URL. O padrão é: url.
project
opcional string
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 de geração, url para URL, score para Pontuação. O padrão é: id.
sort
opcional string
Ordenar. Os valores possíveis são: desc para Decrescente, asc para Crescente. O padrão é: desc.
per_page
opcional integer
Resultados por página. Os valores possíveis são: 10, 25, 50, 100. O padrão é: 10.
Mostrar

Endpoint da API:

GET 
https://seo.tb.digital/api/v1/reports/{id}

Exemplo de requisição: 

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

Endpoint da API:

POST 
https://seo.tb.digital/api/v1/reports

Exemplo de requisição: 

curl --location --request POST 'https://seo.tb.digital/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. O padrão é: 0.
password
opcional string
The password for the report page. Funciona apenas com o campo privacy definido como 2.
Atualizar

Endpoint da API:

PUT PATCH 
https://seo.tb.digital/api/v1/reports/{id}

Exemplo de requisição: 

curl --location --request PUT 'https://seo.tb.digital/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. Funciona apenas com o campo privacy definido como 2.
update
opcional integer
Atualizar. Os valores possíveis são: 0 para Não, 1 para Sim. O padrão é: 0.
Excluir

Endpoint da API:

DELETE 
https://seo.tb.digital/api/v1/reports/{id}

Exemplo de requisição: 

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