Clics par groupe (v2)

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/v2/clicks-by-group?startYmd={startYmd}&endYmd={endYmd}&grpIdxList={grpIdxList}&pages={pages}

{
    "startYmd": "2025-08-01",
    "endYmd": "2025-08-31",
    "grpIdxList": "151,207,209",
    "pages": 1
}

Request Parameters

startYmd date required
Date de début de la requête (ex. : 2025-12-01)
endYmd date required
Date de fin de la requête (ex. : 2025-12-31). La période maximale entre la date de début et la date de fin est d’un mois.
Offre Personal : jusqu’à 7 jours
Offre Premium : jusqu’à 14 jours
grpIdxList string

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.
pages integer required
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

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
Clics par Groupe
grpIdx integer
Groupe de liens (IDX).
grpNm string
Nom du groupe de liens.
acesCnt integer
Nombre total de clics pour tous les liens de ce groupe.
pernCnt integer
Nombre d’utilisateurs uniques ayant cliqué sur les liens de ce groupe.