{
  "title": "Choozle API Vocabulary",
  "description": "Key terms and concepts used in the Choozle Reporting API and platform. Field and enum definitions are transcribed from Choozle's published apiDoc dataset at https://app.choozle.com/apidoc/api_data.json.",
  "terms": [
    {
      "term": "account_id",
      "definition": "Identifier for a Choozle advertising account. Required query parameter on GET /api/reports.",
      "type": "parameter"
    },
    {
      "term": "ad_group_id",
      "definition": "Identifier for an ad group within a campaign. Optional filter on GET /api/reports; accepts one or more comma-separated ids and cannot be combined with campaign_id or campaign_status.",
      "type": "parameter"
    },
    {
      "term": "token",
      "definition": "Authentication token obtained from POST /api/auth, valid for 2 hours from creation. Passed as the `token` request header on every reporting call.",
      "type": "authentication"
    },
    {
      "term": "signature",
      "definition": "HMAC-SHA256 digest, in lowercase hex, of the concatenated email and timestamp, keyed with the account's API private key. Required for token generation; uppercase hex and base64 are rejected.",
      "type": "authentication"
    },
    {
      "term": "clicks",
      "definition": "The total number of times users clicked on an advertisement during the reporting period.",
      "type": "metric"
    },
    {
      "term": "conversions",
      "definition": "The number of attributed conversion events (e.g., purchases, sign-ups) resulting from advertising during the reporting period.",
      "type": "metric"
    },
    {
      "term": "ctr",
      "definition": "Click-Through Rate — the ratio of clicks to impressions, expressed as a decimal (clicks / impressions).",
      "type": "metric"
    },
    {
      "term": "cpc",
      "definition": "Cost Per Click — the average cost in USD for each click received on an advertisement.",
      "type": "metric"
    },
    {
      "term": "cpm",
      "definition": "Cost Per Mille — the cost in USD per one thousand ad impressions.",
      "type": "metric"
    },
    {
      "term": "DSP",
      "definition": "Demand-Side Platform — a system that allows buyers of digital advertising inventory to manage multiple ad exchange and data exchange accounts through one interface. Choozle is a self-service DSP.",
      "type": "concept"
    },
    {
      "term": "CTV",
      "definition": "Connected TV — television content delivered over the internet via smart TVs or streaming devices. Choozle supports CTV advertising channels.",
      "type": "channel"
    },
    {
      "term": "DOOH",
      "definition": "Digital Out-of-Home — digital advertising displayed in public environments such as digital billboards and transit displays. Choozle supports DOOH advertising.",
      "type": "channel"
    },
    {
      "term": "RTB",
      "definition": "Real-Time Bidding — an automated auction process for buying and selling digital advertising impressions in milliseconds as a webpage loads.",
      "type": "concept"
    },
    {
      "term": "date_start",
      "definition": "Beginning of the reporting date range (inclusive), ISO 8601 date. Optional; used alone it returns reports on and after this date.",
      "type": "parameter"
    },
    {
      "term": "date_end",
      "definition": "End of the reporting date range (inclusive), ISO 8601 date. Optional; used alone it returns reports on and before this date.",
      "type": "parameter"
    },
    {
      "term": "campaign_id",
      "definition": "Identifier for a campaign within an account. Optional filter on GET /api/reports; cannot be combined with campaign_status.",
      "type": "parameter"
    },
    {
      "term": "campaign_status",
      "definition": "Campaign status filter on GET /api/reports. One of all, active, inactive, archived. Cannot be combined with campaign_id.",
      "type": "parameter"
    },
    {
      "term": "timestamp",
      "definition": "Current datetime in ISO 8601 format used in the auth signature. Must be within five minutes of the Choozle server's current time.",
      "type": "parameter"
    },
    {
      "term": "account_state",
      "definition": "Account lifecycle enum returned by GET /api/accounts. A: Active; I: Inactive, error with account; C: Cancelled; P: Paused.",
      "type": "enum"
    },
    {
      "term": "status",
      "definition": "Ad group status enum returned by GET /api/accounts. I: Incomplete; U: Unapproved; E: Enabled; D: Disabled; S: Scheduled; W: Error; O: Over Ad Group's Budget; B: Over Ad Group's Daily Budget; C: Campaign Over Budget; A: Campaign Over Daily Budget.",
      "type": "enum"
    },
    {
      "term": "advertiser_cost",
      "definition": "Cost charged to the advertiser for the reported ad group and day.",
      "type": "metric"
    },
    {
      "term": "impressions_won",
      "definition": "Number of impressions won in auction for the reported ad group and day.",
      "type": "metric"
    },
    {
      "term": "impressions_bid_on",
      "definition": "Number of impressions bid on for the reported ad group and day.",
      "type": "metric"
    },
    {
      "term": "win",
      "definition": "Auction win rate for the reported ad group and day.",
      "type": "metric"
    },
    {
      "term": "cpa",
      "definition": "Cost Per Acquisition — the average cost for each attributed conversion.",
      "type": "metric"
    },
    {
      "term": "archived",
      "definition": "Campaign archive flag returned by GET /api/accounts. Y when archived, N otherwise.",
      "type": "enum"
    }
  ],
  "source": "https://app.choozle.com/apidoc/api_data.json",
  "generated": "2026-08-13"
}