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.
List

API endpoint:

GET 
https://seo.altitude-dev.com/api/v1/reports

Request example: 

curl --location --request GET 'https://seo.altitude-dev.com/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
optionnel string
The search query.
search_by
optionnel string
Rechercher par. Les valeurs possibles sont : url pour URL. Valeur par défaut : url.
project
optionnel string
The project name.
result
optionnel string
The report result. Les valeurs possibles sont : good pour Parfait, decent pour Moyen, bad pour Mauvais.
sort_by
optionnel string
Sort by. Les valeurs possibles sont : id pour Date created, generated_at pour Date generated, url pour URL, result pour Result. 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 integer
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. Valeur par défaut : 50.
Show

API endpoint:

GET 
https://seo.altitude-dev.com/api/v1/reports/{id}

Request example: 

curl --location --request GET 'https://seo.altitude-dev.com/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST 
https://seo.altitude-dev.com/api/v1/reports

Request example: 

curl --location --request POST 'https://seo.altitude-dev.com/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 pour Public, 1 pour Privé, 2 pour Mot de passe. Valeur par défaut : 0.
password
optionnel string
The password for the report page. Only works with privacy set to 2.
Update

API endpoint:

PUT PATCH 
https://seo.altitude-dev.com/api/v1/reports/{id}

Request example: 

curl --location --request PUT 'https://seo.altitude-dev.com/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

API endpoint:

DELETE 
https://seo.altitude-dev.com/api/v1/reports/{id}

Request example: 

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