Rapports

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

Point de terminaison de l'API:

GET 
https://seo.gtool.fr/api/v1/reports

Exemple de requête: 

curl --location --request GET 'https://seo.gtool.fr/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
optionnel string
La requête de recherche.
search_by
optionnel string
Rechercher par. Les valeurs possibles sont : :valeur pour :nom. Par défaut : url.
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 : id.
sort
optionnel string
Trier. Les valeurs possibles sont : :valeur pour :nom, :valeur pour :nom. Par défaut : desc.
per_page
optionnel integer
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. Par défaut : 10.
Afficher

Point de terminaison de l'API:

GET 
https://seo.gtool.fr/api/v1/reports/{id}

Exemple de requête: 

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

Point de terminaison de l'API:

POST 
https://seo.gtool.fr/api/v1/reports

Exemple de requête: 

curl --location --request POST 'https://seo.gtool.fr/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
optionnel integer
Report page privacy. Les valeurs possibles sont : :valeur pour :nom, :valeur pour :nom, :valeur pour :nom. Par défaut : 0.
password
optionnel string
The password for the report page. Only works with privacy set to 2.
Mettre à jour

Point de terminaison de l'API:

PUT PATCH 
https://seo.gtool.fr/api/v1/reports/{id}

Exemple de requête: 

curl --location --request PUT 'https://seo.gtool.fr/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 : :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 : 0.
Supprimer

Point de terminaison de l'API:

DELETE 
https://seo.gtool.fr/api/v1/reports/{id}

Exemple de requête: 

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