Campaign Level

List campaigns

Returns a flat list of all campaigns across the given instances with basic metadata.

What is included per campaign:

  • Campaign ID, name, description, and status
  • Start date, first post date, and last post date
  • Instance ID the campaign belongs to

No performance metrics are included — use GET /campaigns/performance for metrics.

get/v2/campaigns

Request

Query parameters

limitnumber
Example:50

Maximum number of items to return per page. Choose any value on the first request, then keep it unchanged on every subsequent request that passes a nextCursor from this endpoint. To change the page size, start a new walk by omitting nextCursor.

nextCursorstring nullable

Opaque cursor returned by the previous page. Omit on the first request. Cursors are tied to the query parameters of the request that produced them; to paginate, keep every parameter identical across requests and only vary nextCursor. To change filters, sort, or limit, start a new walk by omitting nextCursor.

Response

List of campaigns with metadata

nextCursorstring nullable required

Example response

{
  "data": [
    {
      "campaignId": 49761,
      "campaignName": "Summer Collection 2024",
      "description": "Seasonal product launch",
      "firstPostDate": "2024-06-15T00:00:00.000Z",
      "instanceId": "instance_abc",
      "lastPostDate": "2024-08-15T00:00:00.000Z",
      "startDate": "2024-06-01T00:00:00.000Z",
      "status": "live"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.