Rapports

Notes
Expert level
La clé API doit être envoyée comme un 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://rank.eclixia.com/api/v1/reports

Exemple de requête: 

curl --location --request GET 'https://rank.eclixia.com/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
facultatif string
La requête de recherche.
search_by
facultatif string
Recherche par. Les valeurs possibles sont : url pour URL. Valeur par défaut : url.
project
facultatif string
Le nom du projet.
result
facultatif string
The report result. Les valeurs possibles sont : good pour Bon, decent pour Acceptable, bad pour Mauvais.
sort_by
facultatif 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
facultatif string
Trier. Les valeurs possibles sont : desc pour Décroissant, asc pour Croissant. Valeur par défaut : desc.
per_page
facultatif int
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. Valeur par défaut : 25.
Afficher

Point de terminaison de l'API:

GET 
https://rank.eclixia.com/api/v1/reports/{id}

Exemple de requête: 

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

Point de terminaison de l'API:

POST 
https://rank.eclixia.com/api/v1/reports

Exemple de requête: 

curl --location --request POST 'https://rank.eclixia.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
facultatif 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
facultatif 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://rank.eclixia.com/api/v1/reports/{id}

Exemple de requête: 

curl --location --request PUT 'https://rank.eclixia.com/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. Valeur par défaut : 0.
Supprimer

Point de terminaison de l'API:

DELETE 
https://rank.eclixia.com/api/v1/reports/{id}

Exemple de requête: 

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