リンク一覧
作成された短縮リンクの一覧を取得するAPIです。
取得対象はURLタイプのリンクに限定されます。
投稿リンク、フォームリンク、カードリンクなど、その他のタイプは対象外です。
このAPIはプレミアムプラン以上でご利用いただけます。
Http Header
GET /api/link/v1/list?regStartYmdt={regStartYmdt}®EndYmdt={regEndYmdt}&pages={pages}
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: -
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"regStartYmdt": "2025-08-01 00:00:00",
"regEndYmdt": "2025-08-10 23:59:59",
"pages": 1
}| フィールド | フィールドの説明 | 説明 | 必須 | タイプ |
|---|---|---|---|---|
| linkId | リンクID | リンクIDでリストを照会します。 リンクIDに特殊文字が含まれている場合、URLEncodeが必要です。 | string | |
| domain | ドメイン | リンクドメインでリストを照会します。 ドメインの前に必ず http:// または https:// の値を付ける必要があります。 | string | |
| createTypeIdx | 生成タイプIDX | 0:すべてのリンク、270:Bivoldiダッシュボードで生成したリンク、272:API呼び出しで生成したリンク、274:一括リンク生成 | int | |
| grpIdx | グループID | グループIDでリストを照会します。 値がない場合、基本値0に設定されます。 | int | |
| url | 長いURL | 長いURLでリストを照会します。URLアドレスの部分検索が可能です。 | string | |
| ttl | リンクタイトル | リンクのタイトルでリストを検索します。タイトルの部分検索が可能です。 | string | |
| brandLinkYn | ブランドリンク | リンクIDが自動的に生成されず、直接設定した場合はブランドリンクです。 Y:使用(ブランドリンク), N:使用しない(自動的に生成されたリンク) | Y or N | |
| notfSubscYn | プッシュリンク | Y:使用する、N:使用しない | Y or N | |
| pushNotifyYn | クリック数プッシュ通知 | Y:有効, N:無効 | Y or N | |
| mailNotifyYn | クリック数メール通知 | Y:有効, N:無効 | Y or N | |
| regStartYmdt | 生成開始日 | リンクを作成した開始日で、作成日が開始日と終了日の間に含まれている必要があります。 例 2022-11-08 00:00:00:00 | Date | |
| regEndYmdt | 生成終了日 | リンクを生成した終了日で、生成日が開始日と終了日の間に含まれている必要があります。 例： 2022-11-08 23:59:59 終了日は開始日より1ヶ月以内に設定する必要があります。 | Date | |
| pages | ページ | pages 値はページング処理に使用され、基本値は 1 です。 一ページに基本的に30行が照会され、pagesの値が2日の場合、31行目から30個のデータが照会されます。 | int | |
| delYmd | リンク削除日 | 設定した日付が過ぎると、リンクがシステムによって自動的に削除されます。 値を設定すると、設定された日付より前のデータが照会されます。 はい: 2025-12-31 | Date |
Response
{
"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",
"ttl": "Add YouTube videos using post links to create short links",
"memo": "",
"url": "https://vvd.im/createpostinglinks",
"grpIdx": 0,
"grpNm": "",
"acesCnt": 5072,
"acesCntToday": 315,
"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",
"delYmd": "",
"regYmdt": "2022-11-02 04:27:05",
"modYmdt": "2022-11-02 04:27:05"
},
{
"linkId": "4Rth",
"domain": "https://vvd.bz",
"typeIdx": 103,
"typeNm": "URL",
"ttl": "NAVER",
"memo": "",
"url": "https://vvd.bz/4Rth",
"grpIdx": 128,
"grpNm": "Test",
"acesCnt": 19,
"acesCntToday": 3,
"lastClkYmdt": "2022-11-07 17:20:40",
"longUrl": "https://www.naver.com",
"blockOverseasSticsYn": "N",
"notfSubscYn": "N",
"kakaoNotifyYn": "N",
"pushNotifyYn": "Y",
"mailNotifyYn": "N",
"delYmd": "2025-12-31",
"regYmdt": "2022-11-07 17:10:22",
"modYmdt": "2022-11-07 17:10:22"
}
]
}
}| フィールド | 説明 | タイプ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | レスポンスコード（0：成功） | int | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message | レスポンスメッセージ。レスポンスコードが0以外の場合、関連するメッセージが返されます。 | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| result | extra（追加情報）
list（リンクリスト） - 配列
| array |