Reportes

Notas
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

API endpoint:

GET 
https://seo.poscali.cl/api/v1/reports

Request example: 

curl --location --request GET 'https://seo.poscali.cl/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Descripción
search
opcional string
The search query.
search_by
opcional string
Buscar por. Possible values are: url for URL. Defaults to: url.
project
opcional string
The project name.
result
opcional string
The report result. Possible values are: good for Bueno, decent for Decente, bad for Malo.
sort_by
opcional string
Ordenar por. Possible values are: id for Date created, generated_at for Date generated, url for URL, result for Resultado. Defaults to: id.
sort
opcional string
Ordenar. Possible values are: desc for Descendente, asc for Ascendente. Defaults to: desc.
per_page
opcional int
Resultados por página. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Show

API endpoint:

GET 
https://seo.poscali.cl/api/v1/reports/{id}

Request example: 

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

API endpoint:

POST 
https://seo.poscali.cl/api/v1/reports

Request example: 

curl --location --request POST 'https://seo.poscali.cl/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Type
Descripción
url
requerido string
The webpage's URL.
privacy
opcional integer
Report page privacy. Possible values are: 0 for Público, 1 for Privado, 2 for Contraseña. Defaults to: 1.
password
opcional string
The password for the report page. Only works with privacy set to 2.
Update

API endpoint:

PUT PATCH 
https://seo.poscali.cl/api/v1/reports/{id}

Request example: 

curl --location --request PUT 'https://seo.poscali.cl/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Descripción
privacy
opcional integer
Report page privacy. Possible values are: 0 for Público, 1 for Privado, 2 for Contraseña.
password
opcional string
The password for the report page. Only works with privacy set to 2.
results
opcional integer
Update the report results. Possible values are: 0 for No, 1 for Si. Defaults to: 0.
Eliminar

API endpoint:

DELETE 
https://seo.poscali.cl/api/v1/reports/{id}

Request example: 

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