Rapports

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

Noeud final d'API:

GET 
https://ariane.mozartsduweb.com/api/v1/reports

Exemple de demande: 

curl --location --request GET 'https://ariane.mozartsduweb.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
Rechercher par. Les valeurs possibles sont: url pour: nom. Valeur par défaut: url.
project
facultatif string
Nom du projet.
result
facultatif string
The report result. Les valeurs possibles sont: good pour: nom, decent pour: nom, bad pour: nom.
sort_by
facultatif string
Trier par. Les valeurs possibles sont: id pour: nom, generated_at pour: nom, url pour: nom, result pour: nom. Valeur par défaut: id.
sort
facultatif string
Trier. Les valeurs possibles sont: desc pour: nom, asc pour: nom. 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: 10.
Afficher

Noeud final d'API:

GET 
https://ariane.mozartsduweb.com/api/v1/reports/{id}

Exemple de demande: 

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

Noeud final d'API:

POST 
https://ariane.mozartsduweb.com/api/v1/reports

Exemple de demande: 

curl --location --request POST 'https://ariane.mozartsduweb.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
obligatoire string
The webpage's URL.
privacy
facultatif integer
Report page privacy. Les valeurs possibles sont: 0 pour: nom, 1 pour: nom, 2 pour: nom. Valeur par défaut: 1.
password
facultatif string
The password for the report page. Only works with privacy set to 2.
Mise à jour

Noeud final d'API:

PUT PATCH 
https://ariane.mozartsduweb.com/api/v1/reports/{id}

Exemple de demande: 

curl --location --request PUT 'https://ariane.mozartsduweb.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: nom, 1 pour: nom, 2 pour: nom.
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: nom, 1 pour: nom. Valeur par défaut: 0.
Supprimer

Noeud final d'API:

DELETE 
https://ariane.mozartsduweb.com/api/v1/reports/{id}

Exemple de demande: 

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