AdnovaDocs
Analytics

List metrics

Returns every metric and conversion you can reference for this ad account: - Platform metrics (e.g. spend, impressions, clicks) — what Meta or TikTok reports natively. - Adnova metrics (e.g. roas, cpa) — computed on top of platform data. - Custom metrics — formulas you define in the Adnova app. - Custom conversions (Meta only) — conversion events configured in Meta. - First-party integration metrics (Northbeam, Triple Whale) — on demand via includeFirstPartyIntegrations, returned under firstPartyIntegrations when that integration is connected. Pass the metric ids in requestedMetrics on Fetch ad insights, or reference them from filter conditions.

GET
/metrics

Authentication

authentication
api-key<token>

Create an API key from the Adnova dashboard (Account integrations). Pass the key value in the api-key request header on every call.

In: header

Query Parameters

platform*string

Ad platform the account lives on. Must match the platform field on the ad account row from List ad accounts.

Value in"facebook" | "tiktok"
adAccountId*string

AdAccountId required to map the platform account. Read id from the List Ad Accounts response. Pass it as adAccountId to Analytics endpoints.

Length1 <= length
workspaceId*string

Workspace this ad account is attached to. Get it from List workspaces or List ad accounts.

Length1 <= length
includeFirstPartyIntegrations?array<>

First-party integrations whose metric catalog to also return, under firstPartyIntegrations in the response. Repeat the parameter for multiple (e.g. ?includeFirstPartyIntegrations=triplewhale&includeFirstPartyIntegrations=northbeam). Each is returned only if connected for this workspace (Triple Whale is Meta-only); not-connected requests are omitted without error.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.adnova.ai/analytics/v1/metrics?platform=facebook&adAccountId=string&workspaceId=string"
{
  "platform": "facebook",
  "adAccountId": "string",
  "workspaceId": "string",
  "supportedMetrics": {
    "property1": {
      "longName": "string",
      "shortName": "string",
      "description": "string",
      "formula": "string",
      "suffix": "string"
    },
    "property2": {
      "longName": "string",
      "shortName": "string",
      "description": "string",
      "formula": "string",
      "suffix": "string"
    }
  },
  "customMetrics": [
    {
      "_id": "string",
      "longName": "string",
      "shortName": "string",
      "description": "string",
      "formula": "string",
      "format": "string",
      "dependentMetrics": [
        "string"
      ],
      "requiresCustomConversions": true
    }
  ],
  "customConversions": [
    {
      "id": "string",
      "name": "string",
      "custom_event_type": "string"
    }
  ],
  "firstPartyIntegrations": {
    "property1": {
      "property1": {
        "longName": "string",
        "shortName": "string",
        "description": "string",
        "formula": "string",
        "suffix": "string"
      },
      "property2": {
        "longName": "string",
        "shortName": "string",
        "description": "string",
        "formula": "string",
        "suffix": "string"
      }
    },
    "property2": {
      "property1": {
        "longName": "string",
        "shortName": "string",
        "description": "string",
        "formula": "string",
        "suffix": "string"
      },
      "property2": {
        "longName": "string",
        "shortName": "string",
        "description": "string",
        "formula": "string",
        "suffix": "string"
      }
    }
  }
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}
{
  "error": {
    "code": "string",
    "message": "string"
  },
  "message": "string"
}