Rapports

Notes
Expert level
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.
Liste

Point d'accès à l'API:

GET 
https://mail.gi-seo.fr/api/v1/reports

Exemple de requête: 

curl --location --request GET 'https://mail.gi-seo.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
Recherche par. Les valeurs possibles sont : url for URL. La valeur par défaut est : url.
project
optionnel string
Le nom du projet.
result
optionnel string
The report result. Les valeurs possibles sont : good for Bon, decent for Correct, bad for Mauvais.
sort_by
optionnel string
Trier par. Les valeurs possibles sont : id for Date de création, generated_at for Date de création, url for URL, result for Résultat. La valeur par défaut est : id.
sort
optionnel string
Trier. Les valeurs possibles sont : desc for Descendant, asc for Ascendant. La valeur par défaut est : desc.
per_page
optionnel int
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. La valeur par défaut est : 10.
Afficher

Point d'accès à l'API:

GET 
https://mail.gi-seo.fr/api/v1/reports/{id}

Exemple de requête: 

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

Point d'accès à l'API:

POST 
https://mail.gi-seo.fr/api/v1/reports

Exemple de requête: 

curl --location --request POST 'https://mail.gi-seo.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 : 0 for Public, 1 for Private, 2 for Mot de passe. La valeur par défaut est : 1.
password
optionnel string
The password for the report page. Only works with privacy set to 2.
Mise à jour

Point d'accès à l'API:

PUT PATCH 
https://mail.gi-seo.fr/api/v1/reports/{id}

Exemple de requête: 

curl --location --request PUT 'https://mail.gi-seo.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 : 0 for Public, 1 for Private, 2 for Mot de passe.
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 : 0 for Non, 1 for Oui. La valeur par défaut est : 0.
Supprimer

Point d'accès à l'API:

DELETE 
https://mail.gi-seo.fr/api/v1/reports/{id}

Exemple de requête: 

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