Liens

Notes
Niveau expert
La clé API doit être envoyée en tant que jeton Bearer dans l'en-tête d'autorisation de la requête. Obtenez votre clé API.
Lister

Point de terminaison API:

GET 
https://stats.tomco.tech/api/v1/links

Exemple de requête: 

curl --location --request GET 'https://stats.tomco.tech/api/v1/links' \
--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
Rechercher par. Les valeurs possibles sont : title pour Titre, alias pour Alias, url pour URL. La valeur par défaut est : title.
status
optionnel integer
Filtrer par statut. Les valeurs possibles sont : 0 pour Tout, 1 pour Actif, 2 pour Expiré, 3 pour Désactivé. La valeur par défaut est : 0.
space_id
optionnel integer
Filtrer par ID d'espace.
domain_id
optionnel integer
Filtrer par ID de domaine.
pixel_id
optionnel integer
Filtrer par ID de pixel.
sort_by
optionnel string
Trier par. Les valeurs possibles sont : id pour Date de création, clicks pour Clics, title pour Titre, alias pour Alias, url pour URL. La valeur par défaut est : id.
sort
optionnel string
Trier. Les valeurs possibles sont : desc pour Décroissant, asc pour Croissant. La valeur par défaut est : desc.
per_page
optionnel integer
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. La valeur par défaut est : 10.
Montrer

Point de terminaison API:

GET 
https://stats.tomco.tech/api/v1/links/{id}

Exemple de requête: 

curl --location --request GET 'https://stats.tomco.tech/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Magasin

Point de terminaison API:

POST 
https://stats.tomco.tech/api/v1/links

Exemple de requête: 

curl --location --request POST 'https://stats.tomco.tech/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
Paramètre
Type
Description
url
requis string
Le lien à raccourcir.
domain_id
requis integer
L'ID de domaine sous lequel le lien doit être enregistré.
alias
optionnel string
L'alias de lien.
password
optionnel string
Le mot de passe du lien.
space_id
optionnel integer
L'ID d'espace sous lequel le lien doit être enregistré.
pixel_ids
optionnel array
The pixel IDs to be integrated in the link.
disabled
optionnel integer
Si le lien est désactivé ou non. Les valeurs possibles sont : 0 pour Actif, 1 pour Désactivé. La valeur par défaut est : 0.
privacy
optionnel integer
Si les statistiques de lien sont publiques ou non. Les valeurs possibles sont : 0 pour Public, 1 pour Privé, 2 pour Mot de passe. La valeur par défaut est : 0.
privacy_password
optionnel string
Le mot de passe pour la page de statistiques. Fonctionne uniquement avec : privacy défini sur : 2.
expiration_url
optionnel string
Le lien vers lequel l'utilisateur sera redirigé une fois le lien expiré.
expiration_date
optionnel string
La date d'expiration du lien au format : YYYY-MM-DD.
expiration_time
optionnel string
L'heure d'expiration du lien au format : HH:MM.
expiration_clicks
optionnel integer
Le nombre de clics après lesquels le lien devrait expirer.
target_type
optionnel integer
Le type de ciblage. Les valeurs possibles sont : 0 pour Aucun, 1 pour Géographique, 2 pour Plateforme, 4 pour Rotation.
country[index][key]
optionnel string
Le code du pays cible. Le code doit être conforme à la norme : ISO 3166-1 alpha-2.
country[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
platform[index][key]
optionnel string
Le nom de la plateforme cible. Les valeurs possibles sont : iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
language[index][key]
optionnel string
Le code de la langue cible. Le code doit être conforme à la norme : ISO 639-1 alpha-2.
language[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
rotation[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
Mettre à jour

Point de terminaison API:

PUT PATCH 
https://stats.tomco.tech/api/v1/links/{id}

Exemple de requête: 

curl --location --request PUT 'https://stats.tomco.tech/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Paramètre
Type
Description
url
optionnel string
Le lien à raccourcir.
alias
optionnel string
L'alias de lien.
password
optionnel string
Le mot de passe du lien.
space_id
optionnel integer
L'ID d'espace sous lequel le lien doit être enregistré.
pixel_ids
optionnel array
The pixel IDs to be integrated in the link.
disabled
optionnel integer
Si le lien est désactivé ou non. Les valeurs possibles sont : 0 pour Actif, 1 pour Désactivé.
privacy
optionnel integer
Si les statistiques de lien sont publiques ou non. Les valeurs possibles sont : 0 pour Public, 1 pour Privé, 2 pour Mot de passe.
privacy_password
optionnel string
Le mot de passe pour la page de statistiques. Fonctionne uniquement avec : privacy défini sur : 2.
expiration_url
optionnel string
Le lien vers lequel l'utilisateur sera redirigé une fois le lien expiré.
expiration_date
optionnel string
La date d'expiration du lien au format : YYYY-MM-DD.
expiration_time
optionnel string
L'heure d'expiration du lien au format : HH:MM.
expiration_clicks
optionnel integer
Le nombre de clics après lesquels le lien devrait expirer.
target_type
optionnel integer
Le type de ciblage. Les valeurs possibles sont : 0 pour Aucun, 1 pour Géographique, 2 pour Plateforme, 4 pour Rotation.
country[index][key]
optionnel string
Le code du pays cible. Le code doit être conforme à la norme : ISO 3166-1 alpha-2.
country[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
platform[index][key]
optionnel string
Le nom de la plateforme cible. Les valeurs possibles sont : iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
language[index][key]
optionnel string
Le code de la langue cible. Le code doit être conforme à la norme : ISO 639-1 alpha-2.
language[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
rotation[index][value]
optionnel string
Le lien vers lequel l'utilisateur sera redirigé.
Supprimer

Point de terminaison API:

DELETE 
https://stats.tomco.tech/api/v1/links/{id}

Exemple de requête: 

curl --location --request DELETE 'https://stats.tomco.tech/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'