GET
/api/v4/locations/{locationId}/bulk-posts拠点の一括投稿を取得
指定した1つの拠点を含む一括(複数拠点)投稿キャンペーンを、1ページ分返します。
パラメーター
パス
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| locationId | string | 必須 | Base64-encoded location cursor / global ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). Pass it unchanged, do not URL-encode it. The base64 cursor always resolves; the raw numeric database ID also works on this endpoint, but the base64 form is the portable choice across the API. |
クエリ
| 名前 | 型 | 必須 | 説明 | デフォルト |
|---|---|---|---|---|
| page | integer | 任意 | 1-based page number for offset pagination. | 1 |
| perPage | integer | 任意 | Number of records per page. | — |
| filters | string | 任意 | JSON-encoded SocialPostFiltersInput (e.g. by `type`, `status`, `creationDateRange`, `siteUrls`). | — |
| sortFields | string | 任意 | JSON-encoded sort object `{ "field": "created_at", "order": "Descending" }`. `field` is one of name, type, status, created_at, schedule_start_date, schedule_end_date, client_name, clicks, views, shares. | — |
| locationIds | string | 任意 | JSON-encoded array of location IDs to include alongside the path location. | — |
| componentIdentifier | string | 任意 | Filter to campaigns created by a specific component/integration. | — |
レスポンス
200A page of bulk campaigns that include the location. `records` is empty when no bulk campaign has targeted it.
{ "data": { "rollupSocialPosts": { "records": [ { "id": "U29jaWFsUG9zdDo1MTA4OA==", "name": "Diwali Offer - All Stores", "status": "SUCCESS", "type": "OFFER", "createdAt": "2026-06-20", "scheduledStartDate": "2026-06-22", "scheduledEndDate": "2026-07-06", "views": 4210, "clicks": 318, "shares": 12, "reactions": 87, "comments": 4, "sites": ["GOOGLE", "FACEBOOK"], "message": [ { "site": "GOOGLE", "message": "Festive savings across all our stores this week." }, { "site": "FACEBOOK", "message": "Festive savings across all our stores this week!" } ], "cta": [ { "type": { "value": "GET_OFFER", "label": "Get offer" }, "url": "https://jennyhome.example/diwali", "site": "GOOGLE", "tinyUrl": "https://tiny.cc/jh-diwali" } ], "contextInfo": { "couponCode": "DIWALI25", "redeemUrl": "https://jennyhome.example/diwali", "termsConditions": "Valid in-store only. Cannot be combined with other offers.", "title": "25% off storewide", "discount": "25%", "startDay": "2026-06-22", "endDay": "2026-07-06" }, "mediaUrl": [ { "url": "https://cdn.listingsapi.com/posts/51088/diwali.jpg", "site": "GOOGLE", "type": "IMAGE" } ], "publishDetails": [ { "site": "GOOGLE", "status": "PUBLISHED", "createdDate": "2026-06-20", "publishedDate": "2026-06-22", "submissionError": null }, { "site": "FACEBOOK", "status": "PUBLISHED", "createdDate": "2026-06-20", "publishedDate": "2026-06-22", "submissionError": null } ], "postLinks": [ { "site": "GOOGLE", "link": "https://www.google.com/maps/place/?post=51088" } ], "locationIds": [1800289, 1800290, 1800291], "clientName": "Jenny Home" } ], "locationDetails": [ { "id": "TG9jYXRpb246MTgwMDI4OQ==", "name": "Jenny Home", "street": "600 Congress Ave, Suite 200", "city": "Austin", "postalCode": "78701", "countryIso": "US", "stateIso": "TX", "stateName": "Texas", "storeId": null } ], "pageInfo": { "totalPages": 1, "hasNextPage": false, "hasPreviousPage": false, "totalRecords": 1 } } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
一括投稿とは、多数の拠点に同時に公開される1つのキャンペーンです(POST /bulk-postsで作成します)。このエンドポイントは、指定した拠点を含む一括キャンペーンを一覧表示するため、複数店舗の集計を1つの店舗の視点から確認できます。レスポンスの構造はGET /locations/{locationId}/postsと同じで、ここで返されるレコードは複数のlocationIdsにまたがるだけです。
ユースケース:チェーン全体への展開結果を照合する。 全店舗で「ディワリ特典」を開始した後、いずれか1つの店舗からGET /locations/1800289/bulk-postsを呼び出して、その店舗にキャンペーンが届いたことを確認し、共有のcontextInfo(クーポンコード、割引、利用条件)を調べ、サイトごとのpublishDetailsを読んで、その拠点のFACEBOOK submissionErrorを見つけます。
注意点。
- 単一拠点の一覧と同様に、ページネーションは
page/perPageによるオフセット方式で、sortFieldsは単一のオブジェクト(配列ではありません)であり、頻繁にポーリングするとHTTP 429が返される場合があります。 - 各レコードの
locationIdsはキャンペーンの対象となった拠点の完全な集合であり、パス内のID以外のIDも含まれます。
上記のrecords配列は代表的な例です。実際のシード拠点(Jenny Home)には一括キャンペーンがないため、実際に呼び出すとpageInfo.totalRecords: 0を伴うrecords: []が返されます。
Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/bulk-posts' \ -H "Authorization: API $LISTINGSAPI_KEY"