Lista de enlaces

API para consultar la lista de enlaces cortos generados.

Esta API solo está disponible en planes Premium o superiores.

GET

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

{
    "regStartYmdt": "2025-09-01 00:00:00",
    "regEndYmdt": "2025-09-10 23:59:59",
    "pages": 1
}

Request Parameters

regStartYmdtdatetimerequired
Fecha de creación del enlace (Inicio). Especifica la fecha de inicio de la consulta.
Ejemplo: 2025-09-01 00:00:00
regEndYmdtdatetimerequired
Fecha de creación del enlace (Fin). Especifica la fecha de fin de la consulta.
Ejemplo: 2025-09-10 23:59:59
pagesintegerrequired
Número de página. El valor por defecto es 1.
Cada página devuelve 30 resultados. Por ejemplo, si pages=2, devuelve desde el registro 31.
linkIdstring
ID del enlace.
domainstring
Dominio del enlace.
createTypeIdxinteger
Método de creación del enlace.
0: Todos los enlaces, 270: Creado desde el panel, 272: Creado vía API, 274: Creado por carga de Excel.
grpIdxinteger
Grupo de enlaces.
urlstring
URL original. Introduzca una URL completa que comience con “https://”.
No se admiten búsquedas por URL parcial.
ttlstring
Título del enlace. Se admite búsqueda parcial.
Si incluye espacios o caracteres Unicode, se recomienda la codificación URL.
brandLinkYnstring
Indica si es un enlace de marca.
memostring
Nota para la gestión del enlace. Se admite búsqueda parcial.
Si incluye espacios o caracteres Unicode, se recomienda la codificación URL.
notfSubscYnstring
Indica si es un enlace de suscripción push.
qrBypassYn string
Predeterminado:N
Enum:
YN
Controla si se debe omitir el enlace corto al escanear un código QR y acceder directamente a la URL original configurada por el usuario.
Y: Redirige directamente a la URL original sin pasar por el enlace corto. (No se registran estadísticas de escaneo QR)
N: Pasa por el enlace corto antes de redirigir a la URL original. (Se registran estadísticas de escaneo QR)
pushNotifyYnstring
Indica si las notificaciones push de clics están activadas.
mailNotifyYnstring
Indica si las notificaciones por correo de clics están activadas.
startDelYmdt datetime
Fecha y hora de inicio de la eliminación del enlace.
endDelYmdt datetime
Fecha y hora de finalización de la eliminación del enlace.
{
    "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
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
Información del Enlace
linkIdstring
ID del enlace.
domainstring
Dominio.
typeIdxinteger
Default:103
Enum:
103104106107108119447
Tipo de enlace (IDX). 103: URL, 104: Publicación, 106: Enlace Profundo, 107: Botón, 108: Tarjeta, 119: QR, 447: Formulario.
typeNmstring
Tipo de enlace (Nombre).
redirectType integer
Default:302
Enum:
200301302
Tipo de redirección.
Consulta la página de Términos para más detalles.
Esta función está disponible en planes Personales o superiores.
ttlstring
Título del enlace.
description string
Cuando redirectType es 200, se puede establecer la metaetiqueta description.
metaImg string
Cuando redirectType es 200, se puede establecer la metaetiqueta image.
La URL de la imagen debe comenzar con https://.
memostring
Nota para la gestión del enlace.
urlstring
URL corta.
grpIdxinteger
Grupo de enlaces (IDX).
grpNmstring
Grupo de enlaces (Nombre).
acesCntinteger
Número total de clics.
acesCntTodayinteger
Clics de hoy.
acesMaxCnt integer
Número máximo de clics permitidos.
pernCnt integer
Número de usuarios únicos (clics únicos).
lastClkYmdtdatetime
Fecha del último clic.
longUrlstring
URL original.
notfSubscYnstring
Indica si es un enlace de suscripción push.
qrBypassYn string
Predeterminado:N
Enum:
YN
Controla si se debe omitir el enlace corto al escanear un código QR y acceder directamente a la URL original configurada por el usuario.
Y: Redirige directamente a la URL original sin pasar por el enlace corto. (No se registran estadísticas de escaneo QR)
N: Pasa por el enlace corto antes de redirigir a la URL original. (Se registran estadísticas de escaneo QR)
pushNotifyYnstring
Indica si están habilitadas las notificaciones push de clics.
mailNotifyYnstring
Indica si están habilitadas las notificaciones por correo electrónico de clics.
strtYmdt datetime
Fecha y hora de inicio de la validez.
endYmdt datetime
Fecha y hora de finalización de la validez.
expireUrl string
URL a la que se redirige tras la expiración.
pwd string
Contraseña de acceso al enlace.
Obligatoria al intentar acceder al enlace.
nonmemberSticsPwd string
Contraseña de estadísticas del enlace.
Necesaria para consultar clics y datos analíticos. Compártala solo con usuarios autorizados.
webhookEnableYn string
Enum:
YN
Estado de activación del Webhook.
webhookMetric string
Enum:
CP
Criterio de recepción del Webhook.
C: Basado en número de clics, P: Basado en usuarios únicos.
webhookFrequency integer
Enum:
1501002003005001000
Frecuencia de recepción del Webhook.
1: Cada clic, 50: Cada 50 clics, 100: Cada 100 clics, 300: Cada 300 clics, 500: Cada 500 clics, 1000: Cada 1.000 clics.
delYmdtdatetime
Fecha programada de eliminación del enlace.
regYmdtdatetime
Fecha de creación.
modYmdtdatetime
Fecha de modificación.