Relatórios

Observações
Expert level
A chave de API deve ser enviada como um token de portador no cabeçalho de autorização da solicitação. Obter sua chave de API.
Lista

Ponto de extremidade da API:

GET
http://seo-tools.maudy.com.br/api/v1/reports

Exemplo de solicitação:

curl --location --request GET 'http://seo-tools.maudy.com.br/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. Padrão para: 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
Classificar por. Os valores possíveis são id para Data de criação, generated_at para Data de criação, url para URL, result para Resultado. Padrão para: id.
sort
opcional string
Ordenar. Os valores possíveis são desc para Descendente, asc para Ascendente. Padrão para: desc.
per_page
opcional int
Resultados por página. Os valores possíveis são 10, 25, 50, 100. Padrão para: 10.
Exibir

Ponto de extremidade da API:

GET
http://seo-tools.maudy.com.br/api/v1/reports/{id}

Exemplo de solicitação:

curl --location --request GET 'http://seo-tools.maudy.com.br/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Loja

Ponto de extremidade da API:

POST
http://seo-tools.maudy.com.br/api/v1/reports

Exemplo de solicitação:

curl --location --request POST 'http://seo-tools.maudy.com.br/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 para: 1.
password
opcional string
The password for the report page. Only works with privacy set to 2.
Atualizar

Ponto de extremidade da API:

PUT PATCH
http://seo-tools.maudy.com.br/api/v1/reports/{id}

Exemplo de solicitação:

curl --location --request PUT 'http://seo-tools.maudy.com.br/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 para: 0.
Excluir

Ponto de extremidade da API:

DELETE
http://seo-tools.maudy.com.br/api/v1/reports/{id}

Exemplo de solicitação:

curl --location --request DELETE 'http://seo-tools.maudy.com.br/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'