API de liste des liens

Parcourez et recherchez tous vos liens courts.

Filtrez par date de création, ID, domaine, groupe, URL et plus encore pour trouver rapidement ce dont vous avez besoin.

Idéale pour les tableaux de bord, l’analyse et les intégrations de données.
Disponible à partir des offres premium.

GET

/api/link/v1/list?regStartYmdt={regStartYmdt}&regEndYmdt={regEndYmdt}&pages={pages} 


GET /api/link/v1/list
     ?regStartYmdt=2025-09-01+00%3A00%3A00
     &endYmd=2025-09-10+23%3A59%3A59
     &pages=1

Request Parameters

regStartYmdtdatetimerequired
Date de création du lien (Début). Spécifie la date de début de la requête.
Exemple : 2025-09-01 00:00:00
regEndYmdtdatetimerequired
Date de création du lien (Fin). Spécifie la date de fin de la requête.
Exemple : 2025-09-10 23:59:59
pagesintegerrequired
Numéro de page. La valeur par défaut est 1.
Chaque page renvoie 30 résultats par défaut. Par exemple, si pages=2, les résultats sont renvoyés à partir du 31e enregistrement.
linkIdstring
ID du lien.
domainstring
Domaine du lien.
createTypeIdxinteger
Méthode de création du lien.
0 : Tous les liens, 270 : Créé depuis le tableau de bord, 272 : Créé via l’API, 274 : Créé par import Excel.
grpIdxinteger
Groupe de liens.
urlstring
URL d’origine. Veuillez saisir une URL complète commençant par « https:// ».
La recherche par URL partielle n’est pas prise en charge.
ttlstring
Titre du lien. La recherche partielle est prise en charge.
Si des espaces ou des caractères Unicode sont inclus, il est recommandé d’utiliser l’encodage URL.
brandLinkYnstring
Indique s’il s’agit d’un lien de marque.
memostring
Note de gestion du lien. La recherche partielle est prise en charge.
Si des espaces ou des caractères Unicode sont inclus, il est recommandé d’utiliser l’encodage URL.
notfSubscYnstring
Indique s’il s’agit d’un lien d’abonnement push.
qrBypassYn string
Par défaut :N
Enum :
YN
Contrôle s’il faut ignorer le lien court lors du scan d’un code QR et accéder directement à l’URL d’origine définie par l’utilisateur.
Y : Redirige directement vers l’URL d’origine sans passer par le lien court. (Les statistiques de scan QR ne sont pas enregistrées)
N : Passe par le lien court avant de rediriger vers l’URL d’origine. (Les statistiques de scan QR sont enregistrées)
pushNotifyYnstring
Indique si les notifications push de clics sont activées.
mailNotifyYnstring
Indique si les notifications par e-mail de clics sont activées.
startDelYmdt datetime
Date et heure de début de la suppression du lien.
endDelYmdt datetime
Date et heure de fin de la suppression du lien. 
{
    "code": 0,
    "message": "",
    "result": {
        "extra": {
            "pages": 1,
            "nextPages": 1,
            "nextYn": "N",
            "count": 2,
            "totalCount": 2
        },
        "list": [
            {
                "linkId": "createpostinglinks",
                "domain": "https://vvd.im",
                "typeIdx": 103,
                "typeNm": "URL",
                "redirectType": 302,
                "ttl": "Add YouTube videos using post links to create short links",
                "description": "",
                "metaImg": "",
                "memo": "",
                "url": "https://vvd.im/createpostinglinks",
                "grpIdx": 0,
                "grpNm": "",
                "acesCnt": 5072,
                "acesCntToday": 315,
                "acesMaxCnt": 0,
                "pernCnt": 4958,
                "lastClkYmdt": "2022-11-07 04:45:10",
                "longUrl": "https://vivoldi.com/blog/url-shortener/create-posts-link-url-shortener",
                "blockOverseasSticsYn": "N",
                "notfSubscYn": "N",
                "qrBypassYn": "N",
                "pushNotifyYn": "N",
                "mailNotifyYn": "N",
                "strtYmdt": "",
                "endYmdt": "",
                "expireUrl": "",
                "pwd": "",
                "nonmemberSticsPwd": "",
                "webhookEnableYn": "N",
                "webhookMetric": "C",
                "webhookFrequency": 1,
                "delYmdt": "",
                "regYmdt": "2022-11-02 04:27:05",
                "modYmdt": "2022-11-02 04:27:05"
            },
            {
                "linkId": "4Rth",
                "domain": "https://vvd.bz",
                "typeIdx": 103,
                "typeNm": "URL",
                "redirectType": 200,
                "description": "Discover diverse information and useful content on Naver's main page.",
                "metaImg": "https://s.pstatic.net/static/www/mobile/edit/2016/0705/mobile_212852414260.png",
                "ttl": "NAVER",
                "memo": "",
                "url": "https://vvd.bz/4Rth",
                "grpIdx": 128,
                "grpNm": "Test",
                "acesCnt": 19,
                "acesCntToday": 3,
                "acesMaxCnt": 1000,
                "pernCnt": 16,
                "lastClkYmdt": "2022-11-07 17:20:40",
                "longUrl": "https://www.naver.com",
                "blockOverseasSticsYn": "N",
                "notfSubscYn": "N",
                "qrBypassYn": "Y",
                "pushNotifyYn": "Y",
                "mailNotifyYn": "N",
                "strtYmdt": "2025-09-01 00:00:00",
                "endYmdt": "2025-09-30 23:59:59",
                "expireUrl": "https://yourdomain.com/event/closed.html",
                "pwd": "",
                "nonmemberSticsPwd": "123456",
                "webhookEnableYn": "Y",
                "webhookMetric": "C",
                "webhookFrequency": 1,
                "delYmdt": "2025-12-31 23:59:59",
                "regYmdt": "2022-11-07 17:10:22",
                "modYmdt": "2022-11-07 17:10:22"
            }
        ]
    }
}

Response Parameters

code integer
Code de réponse : 0 = Succès, autres valeurs = Erreur
message string
Message de réponse. Si le code n’est pas 0, un message d’erreur est renvoyé.
result object
extra object
Informations sur la page et le nombre de données.
pages integer
Numéro de la page actuelle
nextPages integer
Numéro de la page suivante
nextYn string
Indique s’il existe une page suivante
count integer
Nombre d’enregistrements sur la page actuelle
totalCount integer
Nombre total d’enregistrements
list array
Informations sur le Lien
linkIdstring
ID du lien.
domainstring
Domaine.
typeIdxinteger
Default:103
Enum:
103104106107108119447
Type de lien (IDX). 103 : URL, 104 : Publication, 106 : Lien Profond, 107 : Bouton, 108 : Carte, 119 : QR, 447 : Formulaire.
typeNmstring
Type de lien (Nom).
redirectType integer
Default:302
Enum:
200301302
Type de redirection.
Voir la page Terminologie pour plus de détails.
Cette fonctionnalité est disponible à partir du forfait Personnel.
ttlstring
Titre du lien.
memostring
Note de gestion du lien.
urlstring
URL courte.
grpIdxinteger
Groupe de liens (IDX).
grpNmstring
Groupe de liens (Nom).
acesCntinteger
Nombre total de clics.
acesCntTodayinteger
Clics d’aujourd’hui.
acesMaxCnt integer
Nombre maximum de clics autorisés.
pernCnt integer
Nombre d’utilisateurs uniques (clics uniques).
lastClkYmdtdatetime
Date du dernier clic.
longUrlstring
URL d’origine.
notfSubscYnstring
Indique s’il s’agit d’un lien d’abonnement push.
qrBypassYn string
Par défaut :N
Enum :
YN
Contrôle s’il faut ignorer le lien court lors du scan d’un code QR et accéder directement à l’URL d’origine définie par l’utilisateur.
Y : Redirige directement vers l’URL d’origine sans passer par le lien court. (Les statistiques de scan QR ne sont pas enregistrées)
N : Passe par le lien court avant de rediriger vers l’URL d’origine. (Les statistiques de scan QR sont enregistrées)
pushNotifyYnstring
Indique si les notifications push de clics sont activées.
mailNotifyYnstring
Indique si les notifications par e-mail de clics sont activées.
strtYmdt datetime
Date et heure de début de validité.
endYmdt datetime
Date et heure de fin de validité.
expireUrl string
URL de redirection après expiration.
pwd string
Mot de passe d’accès au lien.
Doit être saisi pour accéder au lien.
nonmemberSticsPwd string
Mot de passe des statistiques du lien.
Requis pour consulter les clics et les données analytiques. À partager uniquement avec les utilisateurs autorisés.
webhookEnableYn string
Enum:
YN
Activation du Webhook.
webhookMetric string
Enum:
CP
Critère de réception du Webhook.
C : Basé sur le nombre de clics, P : Basé sur les utilisateurs uniques.
webhookFrequency integer
Enum:
1501002003005001000
Fréquence de réception du Webhook.
1 : À chaque clic, 50 : Tous les 50 clics, 100 : Tous les 100 clics, 300 : Tous les 300 clics, 500 : Tous les 500 clics, 1000 : Tous les 1.000 clics.
delYmdtdatetime
Date planifiée de suppression du lien.
regYmdtdatetime
Date de création.
modYmdtdatetime
Date de modification.

Quand utiliser cette API

Utilisez cette API dans les cas suivants :

  • Consulter les liens par période
  • Filtrer les liens selon des critères précis
  • Afficher des listes de liens dans un tableau de bord
  • Alimenter des analyses ou des intégrations de données
Combinez les filtres pour accéder rapidement aux données recherchées.

Fonctionnalités de recherche

Un filtrage puissant conçu pour évoluer.

  • Période : Recherche par plage de dates de création
  • Pagination : Résultats paginés via le paramètre pages
  • Filtres : Affinez par linkId, domaine, groupe et plus
  • Filtres par statut : Type de création, paramètres et autres attributs
Optimisée pour traiter de grands volumes de données avec rapidité et précision.

Cas d’utilisation

Conçue pour des environnements en production.

  • E-commerce: Récupérer des liens par période et les synchroniser avec les systèmes de stock
  • Publicité: Filtrer par groupe de campagne (grpIdx) pour suivre les liens par canal
  • Automatisation: Identifier les liens proches de l’expiration pour les renouveler ou les supprimer
  • Analyse: Exporter les données vers des outils BI et les combiner avec les données de clics
Indispensable pour les services à grande échelle.

Points à considérer

Vérifiez ces points avant d’exécuter une requête.

  • Une plage de dates étendue peut augmenter le temps de réponse
  • Jusqu’à 30 éléments par page—utilisez la pagination pour tout récupérer
  • Plus de filtres peuvent fortement réduire les résultats
  • Prenez en compte la charge serveur lors du traitement de gros volumes
Définissez une plage adaptée pour garantir des performances stables.