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 de terminaison de l'API:

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

Exemple de demande: 

curl --location --request GET 'https://seo.pcmagency.fr/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
en option string
La requête de recherche.
search_by
en option string
Recherche par. Valeurs possibles are: url pour URL. Defaults to: url.
project
en option string
Le nom du projet.
result
en option string
The report result. Valeurs possibles are: good pour Bon, decent pour Décent, bad pour Mauvais.
sort_by
en option string
Trier par. Valeurs possibles are: id pour Date de création, generated_at pour Date de création, url pour URL, result pour Résultat. Defaults to: id.
sort
en option string
Trier. Valeurs possibles are: desc pour Descendant, asc pour Ascendant. Defaults to: desc.
per_page
en option int
Résultats par page. Valeurs possibles are: 10, 25, 50, 100. Defaults to: 50.
Afficher

Point de terminaison de l'API:

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

Exemple de demande: 

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

Point de terminaison de l'API:

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

Exemple de demande: 

curl --location --request POST 'https://seo.pcmagency.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
en option integer
Report page privacy. Valeurs possibles are: 0 pour Public, 1 pour Privé, 2 pour Mot de passe. Defaults to: 1.
password
en option 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.pcmagency.fr/api/v1/reports/{id}

Exemple de demande: 

curl --location --request PUT 'https://seo.pcmagency.fr/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
privacy
en option integer
Report page privacy. Valeurs possibles are: 0 pour Public, 1 pour Privé, 2 pour Mot de passe.
password
en option string
The password for the report page. Only works with privacy set to 2.
results
en option integer
Update the report results. Valeurs possibles are: 0 pour Non, 1 pour Oui. Defaults to: 0.
Supprimer

Point de terminaison de l'API:

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

Exemple de demande: 

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