Clics par groupe

API pour récupérer le nombre de clics par groupe de liens à une date donnée.

Retourne une liste avec le total des clics agrégés pour tous les liens de chaque groupe.

Un maximum de 30 groupes peut être récupéré par requête. Pour en consulter davantage, utilisez le paramètre pages et appelez l’API plusieurs fois.

Cette API est disponible avec les forfaits Premium et supérieurs.

GET

/api/link/v1/clicks-by-group?ymd={ymd}&grpIdxList={grpIdxList}&pages={pages}

{
    "ymd": "2025-08-01",
    "grpIdxList": "151,207,209",
    "pages": 1
}

Request Parameters

ymddaterequired
Date de référence pour la requête. Exemple : 2025-08-01
grpIdxListstring

Fournir la liste des IDX de groupes séparés par des virgules (,). Exemple : 151,207,209

  • Forfait Premium : La liste des IDX de groupes doit être spécifiée, maximum 5 groupes.
  • Forfait Business : Si omis, les clics de tous les groupes seront récupérés. Il est également possible de spécifier un nombre illimité de groupes.
pagesintegerrequired
Default:1
Numéro de page des résultats.
Chaque page renvoie 30 résultats par défaut. Exemple : si pages=2, les résultats sont renvoyés à partir du 31e enregistrement (30 éléments).
{
    "code": 0,
    "message": "",
    "result": {
        "extra": {
            "pages": 1,
            "nextPages": 1,
            "nextYn": "N",
            "count": 3,
            "totalCount": 3
        },
        "list": [
            {
                "grpIdx": 151,
                "grpNm": "Electronics",
                "acesCnt": 181,
                "pernCnt": 164
            },
            {
                "grpIdx": 207,
                "grpNm": "Kitchenware",
                "acesCnt": 19847,
                "pernCnt": 18095
            },
            {
                "grpIdx": 209,
                "grpNm": "Brian Smith Advertiser Only",
                "acesCnt": 5730,
                "pernCnt": 5409
            }
        ]
    }
}

Response Parameters

codeinteger
Code de réponse : 0 = Succès, autres valeurs = Erreur
messagestring
Message de réponse. Si le code n’est pas 0, un message d’erreur est renvoyé.
resultobject
extraobject
Informations sur la page et le nombre de données.
pagesinteger
Numéro de la page actuelle
nextPagesinteger
Numéro de la page suivante
nextYnstring
Indique s’il existe une page suivante
countinteger
Nombre d’enregistrements sur la page actuelle
totalCountinteger
Nombre total d’enregistrements
listarray
Clics par Groupe
grpIdxinteger
Groupe de liens (IDX).
grpNmstring
Nom du groupe de liens.
acesCntinteger
Nombre total de clics pour tous les liens de ce groupe.
pernCntinteger
Nombre d’utilisateurs uniques ayant cliqué sur les liens de ce groupe.