リンク一覧取得API
短縮URLの一覧を取得・検索できるAPIです。
作成日を基準に、リンクID・ドメイン・グループ・URLなどの条件で柔軟に絞り込めます。
管理画面や分析、データ連携に最適です。
このAPIはプレミアムプラン以上で利用可能です。
GET
/api/link/v1/list?regStartYmdt={regStartYmdt}®EndYmdt={regEndYmdt}&pages={pages}
GET /api/link/v1/list
?regStartYmdt=2025-09-01+00%3A00%3A00
&endYmd=2025-09-10+23%3A59%3A59
&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。
「https://」から始まる完全なURLを入力してください。
部分的なURLでの検索はサポートされていません。 - ttlstring
- リンクタイトル。部分検索が可能です。
空白や日本語などの文字が含まれる場合は、URLエンコードを推奨します。 - brandLinkYnstring
- ブランドリンクかどうか。
- memostring
- リンク管理用メモ。部分検索が可能です。
空白や日本語などの文字が含まれる場合は、URLエンコードを推奨します。 - notfSubscYnstring
- プッシュ購読リンクかどうか。
- qrBypassYn string
- デフォルト:N
-
列挙値:
YN
-
QRコードをスキャンした際、短縮URLを経由せずにユーザーが設定した元のURLへ直接アクセスするかどうかを制御します。
Y: 短縮URLを経由せず元のURLへ直接リダイレクトします。（QRスキャン統計は記録されません）
N: 短縮URLを経由して元のURLへリダイレクトします。（QRスキャン統計は記録されます）
- pushNotifyYnstring
- クリック数のプッシュ通知を有効にするかどうか。
- mailNotifyYnstring
- クリック数のメール通知を有効にするかどうか。
- startDelYmdt datetime
- リンク削除開始日時。
- endDelYmdt datetime
- リンク削除終了日時。
{
"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
- 応答コード: 0 = 成功、それ以外 = エラー
- message string
- 応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
- result object
- extra object
- ページおよびデータ件数情報。
- pages integer
- 現在のページ番号
- nextPages integer
- 次のページ番号
- nextYn string
- 次のページが存在するかどうか
- count integer
- 現在のページのデータ件数
- totalCount integer
- 全データ件数
- list array
- リンク情報
- linkIdstring
- リンクID。
- domainstring
- ドメイン。
- typeIdxinteger
- Default:103
- Enum:
103104106107108119447
- リンク種別 (IDX)。103:URL、104:投稿、106:ディープリンク、107:ボタン、108:カード、119:QR、447:フォーム。
- typeNmstring
- リンク種別 (名称)。
- redirectType integer
- Default:302
-
Enum:
200301302
-
リダイレクト方式です。
詳細は用語集ページをご確認ください。
この機能はパーソナルプラン以上でご利用いただけます。 - ttlstring
- リンクタイトル。
- description string
-
redirectTypeの値が200の場合、descriptionメタタグを設定できます。 - metaImg string
-
redirectTypeの値が200の場合、imageメタタグを設定できます。
画像URLは必ずhttps://で始まる必要があります。 - memostring
- リンク管理用メモ。
- linkIdstring
- リンクID。
- urlstring
- 短縮URL。
- grpIdxinteger
- リンクグループ (IDX)。
- grpNmstring
- リンクグループ (名称)。
- acesCntinteger
- クリック数。
- acesCntTodayinteger
- 本日のクリック数。
- acesMaxCnt integer
- 最大許容クリック数。
- pernCnt integer
- ユニークユーザー数（ユニーククリック）。
- lastClkYmdtdatetime
- 最終クリック日時。
- longUrlstring
- 元のURL。
- notfSubscYnstring
- プッシュ購読リンクかどうか。
- qrBypassYn string
- デフォルト:N
-
列挙値:
YN
-
QRコードをスキャンした際、短縮URLを経由せずにユーザーが設定した元のURLへ直接アクセスするかどうかを制御します。
Y: 短縮URLを経由せず元のURLへ直接リダイレクトします。（QRスキャン統計は記録されません）
N: 短縮URLを経由して元のURLへリダイレクトします。（QRスキャン統計は記録されます）
- pushNotifyYnstring
- クリック数のプッシュ通知を有効にするかどうか。
- mailNotifyYnstring
- クリック数のメール通知を有効にするかどうか。
- strtYmdt datetime
- 有効期間の開始日時。
- endYmdt datetime
- 有効期間の終了日時。
- expireUrl string
- 有効期限後にリダイレクトされるURL。
- pwd string
-
リンクアクセス用パスワード。
アクセス時に必ず入力が必要です。 - nonmemberSticsPwd string
-
リンク統計用パスワード。
クリック数や統計データを確認する際に必要で、許可されたユーザーにのみ共有してください。 - webhookEnableYn string
-
Enum:
YN
- Webhookの有効化設定。
- webhookMetric string
-
Enum:
CP
-
Webhookの受信基準。
C: クリック数基準, P: ユーザー数基準（ユニークユーザー）。 - webhookFrequency integer
-
Enum:
1501002003005001000
-
Webhookの受信頻度。
1: 毎回クリック時, 50: 50回ごと, 100: 100回ごと, 300: 300回ごと, 500: 500回ごと, 1000: 1,000回ごと。 - delYmdtdatetime
- リンク削除予定日。
- regYmdtdatetime
- 作成日時。
- modYmdtdatetime
- 更新日時。
このAPIを利用する場面
次のような場面でご利用ください。
- 作成したリンクを期間別に確認したいとき
- 条件を指定してリンクを絞り込みたいとき
- 管理画面でリンク一覧を表示したいとき
- 分析やデータ連携に活用したいとき
検索機能
スケールに対応した柔軟なフィルタリング機能を提供します。
- 期間指定: 作成日で範囲検索
- ページネーション: pagesパラメータで分割取得
- 条件フィルタ: linkId・ドメイン・グループなどで絞り込み
- 状態別検索: 作成タイプや設定状況などで抽出
活用例
実運用に対応した柔軟な活用が可能です。
- ECサイト: 指定期間に作成されたリンクを取得し、在庫管理システムと連携
- 広告運用: キャンペーングループ（
grpIdx）で絞り込み、チャネル別の状況を把握 - 運用自動化: 期限切れ前のリンクを定期取得し、更新または削除を実行
- データ分析: リンクデータをBIツールに連携し、クリックデータと組み合わせて分析
利用時の注意点
取得前に以下をご確認ください。
- 検索期間が広いほど応答時間が長くなる場合があります
- 1ページ最大30件のため、全件取得にはpagesを増やして繰り返し取得が必要です
- フィルタ条件が多いほど結果が絞り込まれます
- 大量データ処理時はサーバー負荷にご注意ください