Informes

Notas
Nivel experto
La clave API debe enviarse como un token Bearer en el encabezado Authorization de la solicitud. Obtenga su clave API.

La API cubre informes, proyectos y datos de la cuenta. No permite ejecutar las herramientas SEO.

Disponible en planes con API; si no, el servidor responde 403. Límites: 60 solicitudes por minuto, 10 por minuto para crear y actualizar informes.

Lista

API endpoint:

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

Ejemplo de solicitud: 

curl --location --request GET 'https://itseo.pro/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parámetro
Tipo
Descripción
search
optional string
La consulta de búsqueda.
search_by
optional string
Buscar por. Possible values are: url for URL. Predeterminado: url.
project
optional string
El nombre del proyecto.
result
optional string
El resultado del informe. Possible values are: good for Bueno, decent for Aceptable, bad for Malo.
sort_by
optional string
Ordenar por. Possible values are: id for Fecha de creación, generated_at for Fecha de generación, url for URL, result for Resultado. Predeterminado: id.
sort
optional string
Sort. Possible values are: desc for Descendente, asc for Ascendente. Predeterminado: desc.
per_page
optional int
Resultados por página. Possible values are: 10, 25, 50, 100. Predeterminado: 100.
Mostrar

API endpoint:

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

Ejemplo de solicitud: 

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

API endpoint:

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

Ejemplo de solicitud: 

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
Descripción
url
required string
La URL de la página web.
privacy
optional integer
Privacidad de la página de informe. Possible values are: 0 for Público, 1 for Privado, 2 for Contraseña. Predeterminado: 1.
password
optional string
La contraseña para la página de informe. Solo funciona cuando privacy está establecido en 2.
Actualizar

API endpoint:

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

Ejemplo de solicitud: 

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
Descripción
privacy
optional integer
Privacidad de la página de informe. Possible values are: 0 for Público, 1 for Privado, 2 for Contraseña.
password
optional string
La contraseña para la página de informe. Solo funciona cuando privacy está establecido en 2.
results
optional integer
Actualizar los resultados del informe. Possible values are: 0 for No, 1 for Sí. Predeterminado: 0.
Eliminar

API endpoint:

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

Ejemplo de solicitud: 

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