Deals

POST /v3/api

Use this method to get your reporting data of the deals

Note: When creative_id or creative_name is selected as a dimension, requests_total and requests_played will always return 0. This is because requests are logged before a creative is selected, so they have no creative associated.

Headers

Name

Value

Authorization

Basic <token>

Body

{
    table: "deals",
    startDate: string, // (format: YYYY-MM-DDThh:mm:ss)
    endDate: string, // (format: YYYY-MM-DDThh:mm:ss)
    fields: [
      { name: "timestamp", as?: string },
      { name: "tag_id", as?: string },
      { name: "tag_name", as?: string },
      { name: "site_id", as?: string },
      { name: "site_name", as?: string },
      { name: "account_id", as?: string },
      { name: "account_name", as?: string },
      { name: "sub_account_id", as?: string },
      { name: "sub_account_name", as?: string },
      { name: "mediatype", as?: string },
      { name: "inventory_type", as?: string },
      { name: "device", as?: string },
      { name: "ssp", as?: string },
      { name: "dealid", as?: string },
      { name: "consent", as?: string },
      { name: "os", as?: string },
      { name: "browser", as?: string },
      { name: "country", as?: string },
      { name: "area", as?: string },
      { name: "domain", as?: string },
      { name: "gpid", as?: string },
      { name: "line_item_id", as?: string },
      { name: "line_item_name", as?: string },
      { name: "split_id", as?: string },
      { name: "split_name", as?: string },
      { name: "segment_id", as?: string },
      { name: "creative_id", as?: string },
      { name: "creative_name", as?: string },
      { name: "order_id", as?: string },
      { name: "order_name", as?: string },
      { name: "advertiser_id", as?: string },
      { name: "advertiser_name", as?: string },
      { name: "start_date", as?: string },
      { name: "end_date", as?: string }
    ],
    metrics: [
      { name: "requests_total", as?: string },
      { name: "requests_played", as?: string },
      { name: "responses", as?: string },
      { name: "impressions", as?: string },
      { name: "clicks", as?: string },
      { name: "viewed", as?: string },
      { name: "revenue_net_eur", as?: string },
      { name: "revenue_net_usd", as?: string },
      { name: "revenue_gross_eur", as?: string },
      { name: "revenue_gross_usd", as?: string }
    ],
    timeSplit: "day"
  }

{
    table: "deals",
    startDate: string, // (format: YYYY-MM-DDThh:mm:ss)
    endDate: string, // (format: YYYY-MM-DDThh:mm:ss)
    fields: [
      { name: "timestamp", as?: string },
      { name: "tag_id", as?: string },
      { name: "tag_name", as?: string },
      { name: "site_id", as?: string },
      { name: "site_name", as?: string },
      { name: "account_id", as?: string },
      { name: "account_name", as?: string },
      { name: "sub_account_id", as?: string },
      { name: "sub_account_name", as?: string },
      { name: "mediatype", as?: string },
      { name: "inventory_type", as?: string },
      { name: "device", as?: string },
      { name: "ssp", as?: string },
      { name: "dealid", as?: string },
      { name: "consent", as?: string },
      { name: "os", as?: string },
      { name: "browser", as?: string },
      { name: "country", as?: string },
      { name: "area", as?: string },
      { name: "domain", as?: string },
      { name: "gpid", as?: string },
      { name: "line_item_id", as?: string },
      { name: "line_item_name", as?: string },
      { name: "split_id", as?: string },
      { name: "split_name", as?: string },
      { name: "segment_id", as?: string },
      { name: "creative_id", as?: string },
      { name: "creative_name", as?: string },
      { name: "order_id", as?: string },
      { name: "order_name", as?: string },
      { name: "advertiser_id", as?: string },
      { name: "advertiser_name", as?: string },
      { name: "start_date", as?: string },
      { name: "end_date", as?: string }
    ],
    metrics: [
      { name: "requests_total", as?: string },
      { name: "requests_played", as?: string },
      { name: "responses", as?: string },
      { name: "impressions", as?: string },
      { name: "clicks", as?: string },
      { name: "viewed", as?: string },
      { name: "revenue_net_eur", as?: string },
      { name: "revenue_net_usd", as?: string },
      { name: "revenue_gross_eur", as?: string },
      { name: "revenue_gross_usd", as?: string }
    ],
    timeSplit: "hour"
  }

[
    {
      "timestamp": "2026-04-01T00:00:00.000Z",
      "tag_id": "tag_abc1",
      "tag_name": "Homepage Banner",
      "site_id": 5001,
      "site_name": "example-site.com",
      "account_id": 1067,
      "account_name": "Nexx360 Demo",
      "sub_account_id": null,
      "sub_account_name": null,
      "mediatype": "banner",
      "inventory_type": "web",
      "device": "Mobile",
      "ssp": "appnexus",
      "dealid": "DEAL-12345",
      "consent": true,
      "os": "iOS",
      "browser": "Safari",
      "country": "FR",
      "area": "IDF",
      "domain": "example.com",
      "gpid": null,
      "line_item_id": "10001",
      "line_item_name": "Campaign Q2",
      "split_id": "50",
      "split_name": "Split A",
      "segment_id": null,
      "creative_id": null,
      "creative_name": null,
      "order_id": "1000",
      "order_name": "Test Order",
      "advertiser_id": "1000",
      "advertiser_name": "Test Advertiser",
      "start_date": "2024-02-05",
      "end_date": "2030-01-01",
      "requests_total": 5000,
      "requests_played": 4200,
      "responses": 0,
      "impressions": 0,
      "clicks": 0,
      "viewed": 0,
      "revenue_net_eur": 0,
      "revenue_net_usd": 0,
      "revenue_gross_eur": 0,
      "revenue_gross_usd": 0
    }
  ]

[
    {
        "message": "'unvalid_name' must be equal to one of the allowed values for table 'deals'",
        "params": {
            "allowedValues": [
                "timestamp",
                "tag_id",
                "tag_name",
                "site_id",
                "site_name",
                "account_id",
                "account_name",
                "sub_account_id",
                "sub_account_name",
                "mediatype",
                "inventory_type",
                "device",
                "ssp",
                "dealid",
                "consent",
                "os",
                "browser",
                "country",
                "area",
                "domain",
                "gpid",
                "line_item_id",
                "line_item_name",
                "split_id",
                "split_name",
                "segment_id",
                "creative_id",
                "creative_name",
                "order_id",
                "order_name",
                "advertiser_id",
                "advertiser_name",
                "start_date",
                "end_date"
            ]
        }
    }
]

PreviousViewed NextDeal Forecast

Last updated 28 days ago

Was this helpful?

{
    table: "deals",
    startDate: string, // (format: YYYY-MM-DDThh:mm:ss)
    endDate: string, // (format: YYYY-MM-DDThh:mm:ss)
    fields: [
      { name: "timestamp", as?: string },
      { name: "tag_id", as?: string },
      { name: "tag_name", as?: string },
      { name: "site_id", as?: string },
      { name: "site_name", as?: string },
      { name: "account_id", as?: string },
      { name: "account_name", as?: string },
      { name: "sub_account_id", as?: string },
      { name: "sub_account_name", as?: string },
      { name: "mediatype", as?: string },
      { name: "inventory_type", as?: string },
      { name: "device", as?: string },
      { name: "ssp", as?: string },
      { name: "dealid", as?: string },
      { name: "consent", as?: string },
      { name: "os", as?: string },
      { name: "browser", as?: string },
      { name: "country", as?: string },
      { name: "area", as?: string },
      { name: "domain", as?: string },
      { name: "gpid", as?: string },
      { name: "line_item_id", as?: string },
      { name: "line_item_name", as?: string },
      { name: "split_id", as?: string },
      { name: "split_name", as?: string },
      { name: "segment_id", as?: string },
      { name: "creative_id", as?: string },
      { name: "creative_name", as?: string },
      { name: "order_id", as?: string },
      { name: "order_name", as?: string },
      { name: "advertiser_id", as?: string },
      { name: "advertiser_name", as?: string },
      { name: "start_date", as?: string },
      { name: "end_date", as?: string }
    ],
    metrics: [
      { name: "requests_total", as?: string },
      { name: "requests_played", as?: string },
      { name: "responses", as?: string },
      { name: "impressions", as?: string },
      { name: "clicks", as?: string },
      { name: "viewed", as?: string },
      { name: "revenue_net_eur", as?: string },
      { name: "revenue_net_usd", as?: string },
      { name: "revenue_gross_eur", as?: string },
      { name: "revenue_gross_usd", as?: string }
    ],
    timeSplit: "hour"
  }

[
    {
      "timestamp": "2026-04-01T00:00:00.000Z",
      "tag_id": "tag_abc1",
      "tag_name": "Homepage Banner",
      "site_id": 5001,
      "site_name": "example-site.com",
      "account_id": 1067,
      "account_name": "Nexx360 Demo",
      "sub_account_id": null,
      "sub_account_name": null,
      "mediatype": "banner",
      "inventory_type": "web",
      "device": "Mobile",
      "ssp": "appnexus",
      "dealid": "DEAL-12345",
      "consent": true,
      "os": "iOS",
      "browser": "Safari",
      "country": "FR",
      "area": "IDF",
      "domain": "example.com",
      "gpid": null,
      "line_item_id": "10001",
      "line_item_name": "Campaign Q2",
      "split_id": "50",
      "split_name": "Split A",
      "segment_id": null,
      "creative_id": null,
      "creative_name": null,
      "order_id": "1000",
      "order_name": "Test Order",
      "advertiser_id": "1000",
      "advertiser_name": "Test Advertiser",
      "start_date": "2024-02-05",
      "end_date": "2030-01-01",
      "requests_total": 5000,
      "requests_played": 4200,
      "responses": 0,
      "impressions": 0,
      "clicks": 0,
      "viewed": 0,
      "revenue_net_eur": 0,
      "revenue_net_usd": 0,
      "revenue_gross_eur": 0,
      "revenue_gross_usd": 0
    }
  ]

hashtagHeaders

hashtagBody

Headers

Body