API de clics por grupo (v2)

Consulta el número de clics por grupo de enlaces en una fecha específica.

La API suma los clics de todos los enlaces dentro de cada grupo y los devuelve en formato de lista.
Permite comparar varios grupos al mismo tiempo y evaluar el rendimiento de las campañas de forma clara.

Esta API está disponible en el plan Personal o superior.

GET

/api/link/v2/clicks-by-group?startYmd={startYmd}&endYmd={endYmd}&grpIdxList={grpIdxList}&pages={pages} 


GET /api/link/v2/clicks-by-group
     ?startYmd=2025-08-01
     &endYmd=2025-08-31
     &grpIdxList=151,207,209
     &pages=1

Request Parameters

startYmd date required
Fecha de inicio de la consulta (ej.: 2025-12-01)
endYmd date required
Fecha de finalización de la consulta (ej.: 2025-12-31). El rango máximo entre la fecha de inicio y la de finalización es de 1 mes.
Plan Personal: hasta 7 días
Plan Premium: hasta 14 días
grpIdxList string

Proporcione la lista de IDX de grupos separados por comas (,). Ejemplo: 151,207,209

  • Plan Premium: Debe especificar la lista de IDX de grupos, hasta 5 grupos permitidos.
  • Plan Business: Si se omite, se consultan los clics de todos los grupos. También se pueden especificar grupos sin límite de cantidad.
pages integer required
Default:1
Número de página de los resultados.
Cada página devuelve 30 resultados por defecto. Ejemplo: si pages=2, se devuelven 30 resultados a partir del registro 31. 
{
    "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
Código de respuesta: 0 = Éxito, otros valores = Error
message string
Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje de error.
result object
extra object
Información de página y número de datos.
pages integer
Número de la página actual
nextPages integer
Número de la siguiente página
nextYn string
Indica si existe una página siguiente
count integer
Número de registros en la página actual
totalCount integer
Número total de registros
list array
Clics por Grupo
grpIdx integer
Grupo de enlaces (IDX).
grpNm string
Nombre del grupo de enlaces.
acesCnt integer
Número total de clics de todos los enlaces en este grupo.
pernCnt integer
Número de usuarios únicos que hicieron clic en los enlaces de este grupo.

Cuándo usar esta API

Utiliza esta API para comparar el rendimiento de varios grupos de campañas en una fecha determinada.

Permite obtener en una sola solicitud los clics totales y usuarios únicos por grupo, ideal para comparaciones y análisis de tráfico por grupo.

Va más allá de una simple consulta y permite análisis comparativo de rendimiento.

Diferencia con otras APIs de clics

Tiempo → “cuándo”, Fecha → “tendencia”, Grupo → “origen”
Esta API está optimizada para comparación de rendimiento.

Cómo consultar múltiples grupos

Puedes consultar varios grupos en una sola solicitud enviando los IDX en grpIdxList, separados por comas (,).
Ejemplo: 151,207,209. Se pueden consultar hasta 30 grupos por solicitud. Para más, usa pages y realiza varias llamadas.

La posibilidad de omitir grpIdxList depende del plan.
En el plan Premium, es obligatorio y permite hasta 5 grupos.
En el plan Business, si se omite se devuelven todos los grupos sin límite.

Casos de uso

  • Comparación de campañas: Usa grpIdxList para comparar varios grupos en una sola solicitud
  • Análisis mensual: Define startYmd y endYmd para analizar clics por grupo
  • Análisis de eventos: (Business+) omite grpIdxList para obtener todos los grupos y generar rankings
  • Dashboards: Recorre páginas para recopilar datos completos y visualizarlos

Aspectos a tener en cuenta

  • Se requiere paginación cuando se consultan muchos grupos.
  • El tiempo de respuesta puede aumentar con grandes volúmenes de datos.
  • El rango máximo de fechas depende del plan. Personal: hasta 7 días, Premium: hasta 14 días.
  • Se devuelven hasta 30 grupos por página. Si el total supera 30, incrementa pages para obtener más resultados.