Brandtrackers

Create a brandtracker

Creates or reactivates a workspace brandtracker by exactly one target identifier: facebookPageId, websiteId, shopId (alias of websiteId), or domain. Domains are normalized and must resolve to exactly one known website. State-changing create/reactivate requests consume one brandtracker create/delete quota unit and one active brandtracker slot; already-active no-ops return 200 and cost 0 units.

post/v1/brandtrackers

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
Auth: HTTP bearer

Request body

facebookPageIdstring

Meta/Facebook page identifier to track. Exactly one of facebookPageId, websiteId, shopId, or domain is required.

websiteIdstring uuid

Website/shop identifier to track as a shop-level brandtracker. Exactly one target identifier is accepted.

shopIdstring uuid

Alias of websiteId for shop-oriented clients. Exactly one target identifier is accepted.

domainstring

Shop domain to resolve to exactly one known website and track as a shop-level brandtracker. Protocols, paths, and a leading www. are normalized away.

folderIdnumber nullable

Workspace brandtracker folder id. Null or omitted attaches the brandtracker at root.

Example request

{
  "facebookPageId": "61554990830184",
  "websiteId": "3d6fd2f0-5b34-4ffc-91ff-f59775544e5f",
  "shopId": "3d6fd2f0-5b34-4ffc-91ff-f59775544e5f",
  "domain": "examplebrand.com",
  "folderId": 42
}

Response

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

requestIdstring required

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

createdboolean required

True when this call created or reactivated a workspace brandtracker; false when an active link already existed.

Example response

{
  "requestId": "5d93d8de-0f6d-46a4-bd10-2e519b7e96bc",
  "data": {
    "id": "1e08fa85-625a-4ba5-b673-d2a4b7bc7c55",
    "name": "Example Brand",
    "facebookPageId": "61554990830184",
    "workspaceLinkId": 99,
    "targetType": "shop",
    "websiteId": "3d6fd2f0-5b34-4ffc-91ff-f59775544e5f",
    "domain": "examplebrand.com",
    "avatarUrl": "https://medias.trendtrack.io/profile_picture/61554990830184.jpg",
    "status": {
      "isLoaded": true,
      "lastCrawledAt": "2026-04-20T10:00:00.000Z"
    },
    "workspaceAddedAt": "2026-04-15T09:00:00.000Z",
    "folder": {
      "id": 42,
      "name": "Competitors"
    },
    "advertising": {
      "activeAds": 18,
      "newAdsLastDay": 3,
      "newAdsLast7Days": 11,
      "newAdsLast30Days": 34
    },
    "websites": [
      {
        "id": "3d6fd2f0-5b34-4ffc-91ff-f59775544e5f",
        "domain": "examplebrand.com",
        "siteName": "Example Brand",
        "trafficNumber": 145230,
        "trafficChange": 12.4,
        "monthlyTraffic": {
          "2026-01": 102343,
          "2026-02": 114230
        },
        "socialNetworks": {
          "facebook": "https://facebook.com/examplebrand",
          "instagram": "https://instagram.com/examplebrand",
          "youtube": "https://youtube.com/@examplebrand"
        }
      }
    ],
    "totalTraffic": 145230
  },
  "created": true
}

Changes

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