Rapports

Notes
Niveau expert
La clé API doit être envoyée en tant que jeton Bearer dans l'en-tête Authorization de la requête. Obtenez votre clé API.

L'API couvre les rapports, les projets et les données du compte. Elle ne permet pas de lancer les outils SEO.

Disponible avec les forfaits incluant l'API ; sinon le serveur répond 403. Limites : 60 requêtes par minute, 10 par minute pour créer et mettre à jour des rapports.

Liste

Point de terminaison API:

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

Exemple de requête: 

curl --location --request GET 'https://itseo.pro/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
facultatif string
La requête de recherche.
search_by
facultatif string
Rechercher par. Les valeurs possibles sont : url pour URL. Par défaut : url.
project
facultatif string
Le nom du projet.
result
facultatif string
Le résultat du rapport. Les valeurs possibles sont : good pour Bon, decent pour Correct, bad pour Mauvais.
sort_by
facultatif string
Trier par. Les valeurs possibles sont : id pour Date de création, generated_at pour Date de génération, url pour URL, result pour Résultat. Par défaut : id.
sort
facultatif string
Trier. Les valeurs possibles sont : desc pour Décroissant, asc pour Croissant. Par défaut : desc.
per_page
facultatif int
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. Par défaut : 100.
Afficher

Point de terminaison API:

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

Exemple de requête: 

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

Point de terminaison API:

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

Exemple de requête: 

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}'
Paramètre
Type
Description
url
requis string
The webpage's URL.
privacy
facultatif integer
Confidentialité de la page de rapport. Les valeurs possibles sont : 0 pour Public, 1 pour Privé, 2 pour Mot de passe. Par défaut : 1.
password
facultatif string
Le mot de passe de la page de rapport. Fonctionne uniquement lorsque privacy est défini sur 2.
Mettre à jour

Point de terminaison API:

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

Exemple de requête: 

curl --location --request PUT 'https://itseo.pro/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
privacy
facultatif integer
Confidentialité de la page de rapport. Les valeurs possibles sont : 0 pour Public, 1 pour Privé, 2 pour Mot de passe.
password
facultatif string
Le mot de passe de la page de rapport. Fonctionne uniquement lorsque privacy est défini sur 2.
results
facultatif integer
Mettre à jour les résultats du rapport. Les valeurs possibles sont : 0 pour Non, 1 pour Oui. Par défaut : 0.
Supprimer

Point de terminaison API:

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

Exemple de requête: 

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