Reportes

Notas
Expert level
La API key debe ser enviada como token Bearer en la cabecera de authorización de la petición. Obtener API key.
Listar

API endpoint:

GET 
https://seometrix.net/api/v1/reports

Ejemplo de petición: 

curl --location --request GET 'https://seometrix.net/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parámetro
Tipo
Descripción
search
opcional string
Criterio de búsqueda.
search_by
opcional string
Buscar por. Los valores posibles son: url para URL. Por default: url.
project
opcional string
Nombre del proyecto.
result
opcional string
The report result. Los valores posibles son: good para Bueno, decent para Decente, bad para Malo.
sort_by
opcional string
Ordenar por. Los valores posibles son: id para Fecha creada, generated_at para Fecha de expedición, url para URL, result para Resultado. Por default: id.
sort
opcional string
Ordenar. Los valores posibles son: desc para Descendente, asc para Ascendente. Por default: desc.
per_page
opcional int
Resultados por página. Los valores posibles son: 10, 25, 50, 100. Por default: 10.
Mostrar

API endpoint:

GET 
https://seometrix.net/api/v1/reports/{id}

Ejemplo de petición: 

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

API endpoint:

POST 
https://seometrix.net/api/v1/reports

Ejemplo de petición: 

curl --location --request POST 'https://seometrix.net/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parámetro
Tipo
Descripción
url
requerido string
The webpage's URL.
privacy
opcional integer
Report page privacy. Los valores posibles son: 0 para Público, 1 para Privado, 2 para Password. Por default: 1.
password
opcional string
The password for the report page. Only works with privacy set to 2.
Actualizar

API endpoint:

PUT PATCH 
https://seometrix.net/api/v1/reports/{id}

Ejemplo de petición: 

curl --location --request PUT 'https://seometrix.net/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parámetro
Tipo
Descripción
privacy
opcional integer
Report page privacy. Los valores posibles son: 0 para Público, 1 para Privado, 2 para Password.
password
opcional string
The password for the report page. Only works with privacy set to 2.
results
opcional integer
Update the report results. Los valores posibles son: 0 para No, 1 para Si. Por default: 0.
Eliminar

API endpoint:

DELETE 
https://seometrix.net/api/v1/reports/{id}

Ejemplo de petición: 

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