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 API:

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

Exemple de requête: 

curl --location --request GET 'https://seo.pulpee.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 : url pour URL. Valeur par défaut : url.
project
optionnel string
Le 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, result pour Résultat. 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 int
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. Valeur par défaut : 10.
Afficher

Point d'accès API:

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

Exemple de requête: 

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

Point d'accès API:

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

Exemple de requête: 

curl --location --request POST 'https://seo.pulpee.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
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 : 1.
password
optionnel string
The password for the report page. Only works with privacy set to 2.
Mettre à jour

Point d'accès API:

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

Exemple de requête: 

curl --location --request PUT 'https://seo.pulpee.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 pour Public, 1 pour Privé, 2 pour 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 pour Non, 1 pour Oui. Valeur par défaut : 0.
Supprimer

Point d'accès API:

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

Exemple de requête: 

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