Workspace

Get workspace ad copies

Returns ad copy analytics aggregated across active workspace brandtrackers in one metered request. One credit is charged per returned row.

get/v1/workspace/ad-copies

Request

Base URL: https://api.trendtrack.io (the document declares no server; this is the origin it was published from)
URL: https://api.trendtrack.io/v1/workspace/ad-copies
Auth: HTTP bearer

Query parameters

pageinteger

limitinteger

Maximum number of workspace aggregate rows to return. Must be <= 100.

brandtrackerIdsstring[]

Optional comma-separated or repeated public brandtracker ids.

folderIdsinteger[]

Optional comma-separated or repeated workspace brandtracker folder ids.

euOnlyboolean

Optional EU-only filter. When true, only EU-classified Facebook ads are included.

order'asc' | 'desc'

sortBy'usageCount' | 'longestRunning'

Response

Paginated workspace ad copies response. The response also includes the X-Request-Id header.

requestIdstring required

Example response

{
  "requestId": "5d93d8de-0f6d-46a4-bd10-2e519b7e96bc",
  "data": [
    {
      "brandtracker": {
        "id": "1e08fa85-625a-4ba5-b673-d2a4b7bc7c55",
        "name": "Acme",
        "facebookPageId": "123456789012345"
      },
      "adCopy": {
        "text": "Get 30% off selected products this week only."
      },
      "metrics": {
        "usageCount": 21,
        "longestRunning": 43
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 128,
    "totalPages": 7
  }
}

Changes

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