Workspace

Get workspace hooks

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

get/v1/workspace/hooks

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/hooks
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' | 'totalImpressions' | 'firstUsedAt' | 'lastUsedAt'

Response

Paginated workspace hooks 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"
      },
      "hook": {
        "text": "Stop scrolling.",
        "sampleAd": {
          "adId": "facebook_123456789",
          "mediaUrl": "https://cdn.example.com/ads/creative.mp4",
          "thumbnailUrl": "https://cdn.example.com/ads/creative-thumb.jpg",
          "fullText": "This is the full transcript text for the sampled ad."
        }
      },
      "metrics": {
        "usageCount": 12,
        "longestRunning": 47,
        "totalImpressions": 152340
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 128,
    "totalPages": 7
  }
}

Changes

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