Sites Web

Notes
Niveau expert
La clé d'API doit être envoyée en tant que Token Bearer dans l'en-tête Authorization de la requête. Obtenir votre clé d'API.
Liste

Point de Terminaison d'API:

GET
https://website.metrics.tn/api/v1/websites

Exemple de demande:

curl --location --request GET 'https://website.metrics.tn/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
facultatif string
Requête de recherche.
sort
facultatif string
Tri. Les valeurs possibles sont: desc pour Z-A, asc pour A-Z.
per_page
facultatif int
Résultats par page. Les valeurs possibles sont: 10 jusqu'à 100. Valeur par défaut: 25.
Afficher

Point de Terminaison d'API:

GET
https://website.metrics.tn/api/v1/websites/{id}

Exemple de demande:

curl --location --request GET 'https://website.metrics.tn/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Ajouter

Point de Terminaison d'API:

POST
https://website.metrics.tn/api/v1/websites

Exemple de demande:

curl --location --request POST 'https://website.metrics.tn/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Paramètre
Type
Description
url
obligatoire string
URL du site Web.
privacy
facultatif integer
Stats 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
Mot de passe de la page de statistiques. Ne fonctionne que avec privacy configuré comme 2.
email
facultatif integer
Rapports électroniques périodiques. Les valeurs possibles sont: 0 pour Désactivé, 1 pour Activé. Valeur par défaut: 0.
exclude_bots
facultatif integer
Exclure le suivi des robots connus. Les valeurs possibles sont: 0 pour Désactivé, 1 pour Activé. Valeur par défaut: 1.
exclude_params
facultatif string
Exclude URL query parameters from being tracked. Un par ligne.
exclude_ips
facultatif string
Exclure le suivi des adresses IP. Un par ligne.
Mettre à jour

Point de Terminaison d'API:

PUT PATCH
https://website.metrics.tn/api/v1/websites/{id}

Exemple de demande:

curl --location --request PUT 'https://website.metrics.tn/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Paramètre
Type
Description
privacy
facultatif integer
Stats page privacy. Les valeurs possibles sont: 0 pour Public, 1 pour Privé, 2 pour Mot de passe.
password
facultatif string
Mot de passe de la page de statistiques. Ne fonctionne que avec privacy configuré comme 2.
email
facultatif integer
Rapports électroniques périodiques. Les valeurs possibles sont: 0 pour Désactivé, 1 pour Activé.
exclude_bots
facultatif integer
Exclure le suivi des robots connus. Les valeurs possibles sont: 0 pour Désactivé, 1 pour Activé.
exclude_params
facultatif string
Exclude URL query parameters from being tracked. Un par ligne.
exclude_ips
facultatif string
Exclure le suivi des adresses IP. Un par ligne.
Supprimer

Point de Terminaison d'API:

DELETE
https://website.metrics.tn/websites/{id}/destroy

Exemple de demande:

curl --location --request DELETE 'https://website.metrics.tn/websites/{id}/destroy' \
--header 'Authorization: Bearer {api_key}'