リンク一覧

作成された短縮リンクの一覧を取得するAPIです。

このAPIはプレミアムプラン以上でのみ利用可能です。

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
リンク作成日（開始日）。検索の開始日を指定します。
例: 2025-09-01 00:00:00
regEndYmdtdatetimerequired
リンク作成日（終了日）。検索の終了日を指定します。
例: 2025-09-10 23:59:59
pagesintegerrequired
ページ番号。デフォルト値は 1 です。
1ページあたり30件の結果が返されます。例えば pages=2 の場合、31件目から30件が返されます。
linkIdstring
リンクID。
domainstring
リンクドメイン。
createTypeIdxinteger
リンク作成方法。
0: 全リンク、270: ダッシュボードで作成、272: API呼び出しで作成、274: Excelアップロードで作成。
grpIdxinteger
リンクグループ。
urlstring
元のURL。部分検索が可能です。
ttlstring
リンクタイトル。部分検索が可能です。
空白や日本語などの文字が含まれる場合は、URLエンコードを推奨します。
brandLinkYnstring
ブランドリンクかどうか。
memostring
リンク管理用メモ。部分検索が可能です。
空白や日本語などの文字が含まれる場合は、URLエンコードを推奨します。
notfSubscYnstring
プッシュ購読リンクかどうか。
blockOverseasSticsYnstring
海外統計をブロックするかどうか。
pushNotifyYnstring
クリック数のプッシュ通知を有効にするかどうか。
mailNotifyYnstring
クリック数のメール通知を有効にするかどうか。
startDelYmdtdatetime
リンク削除開始日時。
endDelYmdtdatetime
リンク削除終了日時。 
{
    "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",
                "kakaoNotifyYn": "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",
                "kakaoNotifyYn": "N",
                "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

codeinteger
応答コード: 0 = 成功、それ以外 = エラー
messagestring
応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
resultobject
extraobject
ページおよびデータ件数情報。
pagesinteger
現在のページ番号
nextPagesinteger
次のページ番号
nextYnstring
次のページが存在するかどうか
countinteger
現在のページのデータ件数
totalCountinteger
全データ件数
listarray
リンク情報
linkIdstring
リンクID。
domainstring
ドメイン。
typeIdxinteger
Default:103
Enum:
103104106107108119447
リンク種別 (IDX)。103:URL、104:投稿、106:ディープリンク、107:ボタン、108:カード、119:QR、447:フォーム。
typeNmstring
リンク種別 (名称)。
redirectTypeinteger
Default:302
Enum:
200301302
リダイレクト方式です。
詳細は用語集ページをご確認ください。
この機能はパーソナルプラン以上でご利用いただけます。
ttlstring
リンクタイトル。
descriptionstring
redirectTypeの値が200の場合、descriptionメタタグを設定できます。
metaImgstring
redirectTypeの値が200の場合、imageメタタグを設定できます。
画像URLは必ずhttps://で始まる必要があります。
memostring
リンク管理用メモ。
linkIdstring
リンクID。
urlstring
短縮URL。
grpIdxinteger
リンクグループ (IDX)。
grpNmstring
リンクグループ (名称)。
acesCntinteger
クリック数。
acesCntTodayinteger
本日のクリック数。
acesMaxCntinteger
最大許容クリック数。
pernCntinteger
ユニークユーザー数（ユニーククリック）。
lastClkYmdtdatetime
最終クリック日時。
longUrlstring
元のURL。
notfSubscYnstring
プッシュ購読リンクかどうか。
blockOverseasSticsYnstring
海外統計をブロックするかどうか。
pushNotifyYnstring
クリック数のプッシュ通知を有効にするかどうか。
mailNotifyYnstring
クリック数のメール通知を有効にするかどうか。
strtYmdtdatetime
有効期間の開始日時。
endYmdtdatetime
有効期間の終了日時。
expireUrlstring
有効期限後にリダイレクトされるURL。
pwdstring
リンクアクセス用パスワード。
アクセス時に必ず入力が必要です。
nonmemberSticsPwdstring
リンク統計用パスワード。
クリック数や統計データを確認する際に必要で、許可されたユーザーにのみ共有してください。
webhookEnableYnstring
Enum:
YN
Webhookの有効化設定。
webhookMetricstring
Enum:
CP
Webhookの受信基準。
C: クリック数基準, P: ユーザー数基準（ユニークユーザー）。
webhookFrequencyinteger
Enum:
1501002003005001000
Webhookの受信頻度。
1: 毎回クリック時, 50: 50回ごと, 100: 100回ごと, 300: 300回ごと, 500: 500回ごと, 1000: 1,000回ごと。
delYmdtdatetime
リンク削除予定日。
regYmdtdatetime
作成日時。
modYmdtdatetime
更新日時。