Rapports

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

Point de terminaison de l'API:

GET
http://ranking-by-assetset.com/api/v1/reports

Exemple de requête:

curl --location --request GET 'http://ranking-by-assetset.com/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
optionnel string
La requête de recherche.
search_by
optionnel string
Recherche par. Les valeurs possibles sont: url pour URL. Defaults to: url.
project
optionnel string
Le nom du projet.
result
optionnel string
The report result. Les valeurs possibles sont: good pour Bon, decent pour Correct, bad pour Mauvais.
sort_by
optionnel 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. Defaults to: id.
sort
optionnel string
Tri. Les valeurs possibles sont: desc pour Déscendant, asc pour Ascendant. Defaults to: desc.
per_page
optionnel int
Résultats par page. Les valeurs possibles sont: 10, 25, 50, 100. Defaults to: 10.
Montrer

Point de terminaison de l'API:

GET
http://ranking-by-assetset.com/api/v1/reports/{id}

Exemple de requête:

curl --location --request GET 'http://ranking-by-assetset.com/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

Point de terminaison de l'API:

POST
http://ranking-by-assetset.com/api/v1/reports

Exemple de requête:

curl --location --request POST 'http://ranking-by-assetset.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
optionnel integer
Report page privacy. Les valeurs possibles sont: 0 pour Public, 1 pour Privé, 2 pour Mot de Passe. Defaults to: 1.
password
optionnel string
The password for the report page. Only works with privacy set to 2.
Update

Point de terminaison de l'API:

PUT PATCH
http://ranking-by-assetset.com/api/v1/reports/{id}

Exemple de requête:

curl --location --request PUT 'http://ranking-by-assetset.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. Defaults to: 0.
Supprimer

Point de terminaison de l'API:

DELETE
http://ranking-by-assetset.com/api/v1/reports/{id}

Exemple de requête:

curl --location --request DELETE 'http://ranking-by-assetset.com/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'