Rapports

Remarques
Expert level
La clé API doit être envoyée en tant que jeton Bearer dans l'en-tête d'autorisation de la demande. Obtenez votre clé API.
Liste

Point de terminaison de l'API:

GET 
https://audit-seo-gratuit.fr/api/v1/reports

Exemple de demande: 

curl --location --request GET 'https://audit-seo-gratuit.fr/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Taper
La description
search
optionnel string
La requête de recherche.
search_by
optionnel string
Recherché par. Les valeurs possibles sont : :valeur pour :nom. Par défaut : :valeur.
project
optionnel string
Le nom du projet.
result
optionnel string
The report result. Les valeurs possibles sont : :valeur pour :nom, :valeur pour :nom, :valeur pour :nom.
sort_by
optionnel string
Trier par. Les valeurs possibles sont : :valeur pour :nom, :valeur pour :nom, :valeur pour :nom, :valeur pour :nom. Par défaut : :valeur.
sort
optionnel string
Trier. Les valeurs possibles sont : :valeur pour :nom, :valeur pour :nom. Par défaut : :valeur.
per_page
optionnel int
résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. Par défaut : :valeur.
Spectacle

Point de terminaison de l'API:

GET 
https://audit-seo-gratuit.fr/api/v1/reports/{id}

Exemple de demande: 

curl --location --request GET 'https://audit-seo-gratuit.fr/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Magasin

Point de terminaison de l'API:

POST 
https://audit-seo-gratuit.fr/api/v1/reports

Exemple de demande: 

curl --location --request POST 'https://audit-seo-gratuit.fr/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Paramètre
Taper
La description
url
obligatoire string
The webpage's URL.
privacy
optionnel integer
Report page privacy. Les valeurs possibles sont : :valeur pour :nom, :valeur pour :nom, :valeur pour :nom. Par défaut : :valeur.
password
optionnel string
The password for the report page. Only works with privacy set to 2.
Mise à jour

Point de terminaison de l'API:

PUT PATCH 
https://audit-seo-gratuit.fr/api/v1/reports/{id}

Exemple de demande: 

curl --location --request PUT 'https://audit-seo-gratuit.fr/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Taper
La description
privacy
optionnel integer
Report page privacy. Les valeurs possibles sont : :valeur pour :nom, :valeur pour :nom, :valeur pour :nom.
password
optionnel string
The password for the report page. Only works with privacy set to 2.
results
optionnel integer
Update the report results. Les valeurs possibles sont : :valeur pour :nom, :valeur pour :nom. Par défaut : :valeur.
Effacer

Point de terminaison de l'API:

DELETE 
https://audit-seo-gratuit.fr/api/v1/reports/{id}

Exemple de demande: 

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