Brandtrackers

Get brandtracker overview

Returns a dashboard-style Brandtracker overview combining graph, media mix, top landing pages, top ads, and ads preview sections. The graph accepts timeSeriesPeriod for rolling windows or timeSeriesStartDate/timeSeriesEndDate for explicit ranges; do not combine them.

get/v1/brandtrackers/{brandtrackerId}/overview

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/brandtrackers/{brandtrackerId}/overview
  • Auth: HTTP bearer

Path parameters

brandtrackerIdstring required

Public brandtracker identifier. This endpoint resolves brandtracker.id inside the authenticated workspace; legacy spyders.uuid values are accepted when migration metadata exists.

Query parameters

euOnlyboolean

Optional EU-only filter forwarded to graph, media mix, landing pages, and top ads sections where supported.

string date
OR
'latest'
Example:2026-04-20

Snapshot date for dashboard time travel. Use YYYY-MM-DD or latest.

cpmnumber

CPM used to estimate spend in the graph section.

timeSeriesGranularity'daily' | 'weekly' | 'monthly'

Bucket size for the graph section. Defaults to daily.

timeSeriesStartDatestring date

Inclusive graph start date. Cannot be combined with timeSeriesPeriod.

timeSeriesEndDatestring date

Inclusive graph end date. Cannot be combined with timeSeriesPeriod.

timeSeriesPeriod'today' | 'yesterday' | '1d' | '7d' | '14d' | '30d' | '90d' | '365d'

Optional rolling window for the graph section. Supports today, yesterday, 1d, 7d, 14d, 30d, 90d, and 365d. Cannot be combined with timeSeriesStartDate or timeSeriesEndDate; snapshotDate may anchor the window.

landingPagesTimePeriod'live' | 'last24h' | 'last3d' | 'last7d' | 'last30d' | 'last3m' | 'last6m' | 'last1y'

Time window for top landing pages. Defaults to live for dashboard-style current overview.

landingPagesLimitinteger

Maximum number of top landing pages to return. Defaults to 5.

topAdsLimitinteger

Maximum number of top ads to return. Defaults to 5.

adsPreviewLimitinteger

Maximum number of ads preview items to return. Defaults to 10.

topAdsSortBy'currentRank' | 'rankDelta' | 'rankDelta7d' | 'rankDelta14d' | 'rankDelta30d' | 'reach' | 'reachDelta1d' | 'reachDelta7d' | 'reachDelta30d' | 'daysRunning' | 'duplicates'

Optional top ads sorting. Defaults to reach when euOnly=true, otherwise daysRunning.

topAdsPeriod'today' | 'yesterday' | 'last1d' | 'last7d' | 'last14d' | 'last30d' | 'total'

Optional top ads period. Supports today, yesterday, last1d, last7d, last14d, last30d, and total. Defaults to total.

Response

Brandtracker overview response. The response also includes the X-Request-Id header.

requestIdstring required

Request identifier mirrored in the X-Request-Id response header.

metaobject required

Reserved response metadata. Snapshot freshness is intentionally omitted from overview to match top-ads.

Example response

{
  "requestId": "5d93d8de-0f6d-46a4-bd10-2e519b7e96bc",
  "data": {
    "graph": {
      "granularity": "daily",
      "dateRange": {
        "startDate": "2026-01-01",
        "endDate": "2026-04-20"
      },
      "adsLaunched": [
        {
          "date": "2026-04-20",
          "count": 12
        }
      ],
      "liveAds": [
        {
          "date": "2026-04-20",
          "count": 12
        }
      ],
      "euImpressionsSpend": [
        {
          "date": "2026-04-20",
          "impressions": 12450,
          "cumulativeImpressions": 431200,
          "estimatedSpend": 112.05
        }
      ],
      "cpm": 9
    },
    "mediaMix": {
      "activeAds": 23,
      "formatCount": {
        "image": 12,
        "video": 8,
        "dco": 2,
        "other": 1
      }
    },
    "topLandingPages": {
      "data": [
        {
          "landingPage": "https://example.com/products/summer-sale",
          "usageCount": 16,
          "longestRunning": 41,
          "totalImpressions": 305400,
          "technologies": [
            {
              "id": "04504d0b-df46-4f62-98b6-d4d9e14a2282",
              "name": "Shopify",
              "iconUrl": "https://cdn.example.com/technology_icons/shopify.svg"
            }
          ]
        }
      ],
      "pagination": {
        "page": 1,
        "limit": 20,
        "total": 128,
        "totalPages": 7
      }
    },
    "topAds": {
      "data": [
        {
          "ad": {
            "id": "facebook_123456789",
            "collationId": "3810635369204881",
            "platform": "facebook",
            "status": "active",
            "createdAt": "2026-04-18T12:30:00.000Z",
            "firstSeenAt": "2026-04-10T00:00:00.000Z",
            "lastSeenAt": "2026-04-19T00:00:00.000Z",
            "daysRunning": 9,
            "media": {
              "type": "video",
              "thumbnailUrl": "https://cdn.example.com/ads/ad-1-thumb.jpg",
              "mediaUrl": "https://cdn.example.com/ads/ad-1.mp4"
            },
            "advertiser": {
              "id": "1234567890",
              "name": "Example Brand",
              "logoUrl": "https://cdn.example.com/pages/example-brand.png",
              "facebookPageId": "1234567890",
              "liveAdsCount": 42,
              "reach30d": 152340,
              "totalReach": 842100,
              "countriesCount": 8,
              "facebookLikes": 125000,
              "instagramFollowers": 89000
            },
            "content": {
              "title": "Summer Sale",
              "body": "Up to 30% off selected products.",
              "transcript": "Save 30% on every order.",
              "callToAction": "Shop now",
              "landingPageUrl": "https://example.com/products/summer-sale",
              "landingPageDomain": "example.com",
              "ctaDescription": "Free shipping on orders over $50.",
              "ctaLinkDescription": "Shop the full collection"
            },
            "metrics": {
              "reach": 152340,
              "aggregatedReach": 284100,
              "estimatedSpend": 4262,
              "duplicates": 4,
              "reachDelta1d": 1200,
              "reachDelta7d": 8200,
              "reachDelta30d": 38400
            },
            "audience": {
              "targetedCountries": [
                "US",
                "FR"
              ],
              "mainCountry": "FR",
              "gender": "all",
              "ageMin": 18,
              "ageMax": 65
            },
            "rank": {
              "positionInPage": 3,
              "currentRank": 12,
              "rankDelta": -4,
              "improvementPct": 0.25
            },
            "flags": {
              "isEuAd": true,
              "hasPartnerBadge": true
            }
          },
          "metrics": {
            "totalReach": 152340,
            "duplicateCount": 4,
            "daysRunning": 27,
            "currentRank": 3
          }
        }
      ],
      "pagination": {
        "page": 1,
        "limit": 20,
        "total": 128,
        "totalPages": 7
      }
    },
    "adsPreview": {
      "data": [
        {
          "id": "facebook_123456789",
          "collationId": "3810635369204881",
          "platform": "facebook",
          "status": "active",
          "createdAt": "2026-04-18T12:30:00.000Z",
          "firstSeenAt": "2026-04-10T00:00:00.000Z",
          "lastSeenAt": "2026-04-19T00:00:00.000Z",
          "daysRunning": 9,
          "media": {
            "type": "video",
            "thumbnailUrl": "https://cdn.example.com/ads/ad-1-thumb.jpg",
            "mediaUrl": "https://cdn.example.com/ads/ad-1.mp4"
          },
          "advertiser": {
            "id": "1234567890",
            "name": "Example Brand",
            "logoUrl": "https://cdn.example.com/pages/example-brand.png",
            "facebookPageId": "1234567890",
            "liveAdsCount": 42,
            "reach30d": 152340,
            "totalReach": 842100,
            "countriesCount": 8,
            "facebookLikes": 125000,
            "instagramFollowers": 89000
          },
          "content": {
            "title": "Summer Sale",
            "body": "Up to 30% off selected products.",
            "transcript": "Save 30% on every order.",
            "callToAction": "Shop now",
            "landingPageUrl": "https://example.com/products/summer-sale",
            "landingPageDomain": "example.com",
            "ctaDescription": "Free shipping on orders over $50.",
            "ctaLinkDescription": "Shop the full collection"
          },
          "metrics": {
            "reach": 152340,
            "aggregatedReach": 284100,
            "estimatedSpend": 4262,
            "duplicates": 4,
            "reachDelta1d": 1200,
            "reachDelta7d": 8200,
            "reachDelta30d": 38400
          },
          "audience": {
            "targetedCountries": [
              "US",
              "FR"
            ],
            "mainCountry": "FR",
            "gender": "all",
            "ageMin": 18,
            "ageMax": 65
          },
          "rank": {
            "positionInPage": 3,
            "currentRank": 12,
            "rankDelta": -4,
            "improvementPct": 0.25
          },
          "flags": {
            "isEuAd": true,
            "hasPartnerBadge": true
          }
        }
      ],
      "pagination": {
        "page": 1,
        "limit": 25,
        "total": 235,
        "totalPages": 10
      }
    }
  },
  "meta": {}
}

Changes

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