Rapports

Notes
Expert level
La clé API doit être envoyée dans l'en-tête Authorization sous forme de jeton Bearer. Obtenir votre clé API.
Lister

Endpoint API:

GET 
https://studioseo.ovh/api/v1/reports

Exemple de requête: 

curl --location --request GET 'https://studioseo.ovh/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
optionnel string
Requête de recherche.
search_by
optionnel string
Rechercher par. Les valeurs possibles sont : url pour URL. Valeur par défaut : url.
project
optionnel string
Nom du projet
result
optionnel string
The report result. Les valeurs possibles sont : good pour Bon, decent pour Correct, bad pour Mauvais.
sort_by
optionnel string
Trier par. Les valeurs possibles sont : id pour Date de création, generated_at pour Date de génération, url pour URL, score pour Score. Valeur par défaut : id.
sort
optionnel string
Trier. Les valeurs possibles sont : desc pour Décroissant, asc pour Croissant. Valeur par défaut : desc.
per_page
optionnel integer
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. Valeur par défaut : 10.
Afficher

Endpoint API:

GET 
https://studioseo.ovh/api/v1/reports/{id}

Exemple de requête: 

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

Endpoint API:

POST 
https://studioseo.ovh/api/v1/reports

Exemple de requête: 

curl --location --request POST 'https://studioseo.ovh/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
obligatoire string
The webpage's URL.
privacy
optionnel integer
Report page privacy. Les valeurs possibles sont : 0 pour Public, 1 pour Privé, 2 pour Mot de passe. Valeur par défaut : 0.
password
optionnel string
The password for the report page. Ne fonctionne que si le champ privacy est défini sur 2.
Mettre à jour

Endpoint API:

PUT PATCH 
https://studioseo.ovh/api/v1/reports/{id}

Exemple de requête: 

curl --location --request PUT 'https://studioseo.ovh/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
privacy
optionnel integer
Report page privacy. Les valeurs possibles sont : 0 pour Public, 1 pour Privé, 2 pour Mot de passe.
password
optionnel string
The password for the report page. Ne fonctionne que si le champ privacy est défini sur 2.
update
optionnel integer
Mettre à jour. Les valeurs possibles sont : 0 pour Non, 1 pour Oui. Valeur par défaut : 0.
Supprimer

Endpoint API:

DELETE 
https://studioseo.ovh/api/v1/reports/{id}

Exemple de requête: 

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