Rapports

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

Point d'accès API:

GET 
https://seo.pixup.ch/api/v1/reports

Exemple de requête: 

curl --location --request GET 'https://seo.pixup.ch/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
facultatif string
Requête de recherche.
search_by
facultatif string
Recherche par. Les valeurs possibles sont: url pour URL. Par défaut: url.
project
facultatif string
Nom du projet.
result
facultatif string
The report result. Les valeurs possibles sont: good pour Excellent, decent pour Correct, bad pour Mauvais.
sort_by
facultatif string
Trier par. Les valeurs possibles sont: id pour Date de création, generated_at pour Date générée, url pour URL, result pour Résultat. Par défaut: id.
sort
facultatif string
Tri. Les valeurs possibles sont: desc pour Descendant, asc pour Ascendant. Par défaut: desc.
per_page
facultatif integer
Résultats par page. Les valeurs possibles sont: 10, 25, 50, 100. Par défaut: 10.
Voir

Point d'accès API:

GET 
https://seo.pixup.ch/api/v1/reports/{id}

Exemple de requête: 

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

Point d'accès API:

POST 
https://seo.pixup.ch/api/v1/reports

Exemple de requête: 

curl --location --request POST 'https://seo.pixup.ch/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
facultatif integer
Report page privacy. Les valeurs possibles sont: 0 pour Public, 1 pour Privé, 2 pour Mot de passe. Par défaut: 0.
password
facultatif string
The password for the report page. Only works with privacy set to 2.
Mise à jour

Point d'accès API:

PUT PATCH 
https://seo.pixup.ch/api/v1/reports/{id}

Exemple de requête: 

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

Point d'accès API:

DELETE 
https://seo.pixup.ch/api/v1/reports/{id}

Exemple de requête: 

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