Skip to content

StatsPublisherSSPApi.md

Latest commit

 

History

History
412 lines (319 loc) · 18 KB

StatsPublisherSSPApi.md

File metadata and controls

412 lines (319 loc) · 18 KB
Raw

StatsPublisherSSPApi

All URIs are relative to https://up.go-adserver.com

Method HTTP request Description
apiV1PublisherSspStatsDetailsGet GET /api/v1/publisher/ssp/stats/details SSP report broken down by one dimension.
apiV1PublisherSspStatsFiltersGet GET /api/v1/publisher/ssp/stats/filters Filter values for the SSP reports.
apiV1PublisherSspStatsFlatGet GET /api/v1/publisher/ssp/stats/flat SSP report grouped by several dimensions.
apiV1PublisherSspStatsGet GET /api/v1/publisher/ssp/stats SSP / smart-campaign earnings.

apiV1PublisherSspStatsDetailsGet

apiV1PublisherSspStatsDetailsGet(from, to, type, ssptype, campaignid, networkid, siteid, country, deviceType, adType, subid, filterBidType)

SSP report broken down by one dimension.

The panel's SSP "details" console: one row per value of `type` (`campaign`, `country`, `website`, `adzone`, `network`, `bid_type`, `keyword`), with request/bid/win funnel, errors and timings. Defaults to every SSP campaign of yours (narrow with `ssptype` or `campaignid`). Capped rows report `truncated: true` + `row_cap`. Money is in currency units (not cents): `paid`, `ecpm`, `avg_bidfloor`, `avg_cpm` (CPM) and `nw_earned`. `avg_resp_time` is seconds. For campaign/country rows, `nw_views` / `nw_clicks` / `nw_earned` carry what the partner's own API reported.

Example

import {
  Configuration,
  StatsPublisherSSPApi,
} from 'goadserver-sdk';
import type { ApiV1PublisherSspStatsDetailsGetRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new StatsPublisherSSPApi(config);

  const body = {
    // Date | Inclusive start. Defaults to 6 days ago (send both from and to). (optional)
    from: 2013-10-20,
    // Date (optional)
    to: 2013-10-20,
    // 'campaign' | 'country' | 'website' | 'adzone' | 'network' | 'bid_type' | 'keyword' (optional)
    type: type_example,
    // 'ssp' | 'external' | 'exchange' (optional)
    ssptype: ssptype_example,
    // Array<number> | One or more SSP campaign ids (`campaignid=1&campaignid=2` or `campaignid[]=…`). (optional)
    campaignid: ...,
    // Array<number> (optional)
    networkid: ...,
    // Array<number> (optional)
    siteid: ...,
    // Array<string> | ISO-3166 alpha-2 codes. (optional)
    country: ...,
    // Array<number> (optional)
    deviceType: ...,
    // Array<number> (optional)
    adType: ...,
    // string (optional)
    subid: subid_example,
    // number | Only this bid type. (optional)
    filterBidType: 56,
  } satisfies ApiV1PublisherSspStatsDetailsGetRequest;

  try {
    const data = await api.apiV1PublisherSspStatsDetailsGet(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
from Date Inclusive start. Defaults to 6 days ago (send both from and to). [Optional] [Defaults to undefined]
to Date [Optional] [Defaults to undefined]
type campaign, country, website, adzone, network, bid_type, keyword [Optional] [Defaults to &#39;campaign&#39;] [Enum: campaign, country, website, adzone, network, bid_type, keyword]
ssptype ssp, external, exchange [Optional] [Defaults to undefined] [Enum: ssp, external, exchange]
campaignid Array<number> One or more SSP campaign ids (`campaignid=1&campaignid=2` or `campaignid[]=…`). [Optional]
networkid Array<number> [Optional]
siteid Array<number> [Optional]
country Array<string> ISO-3166 alpha-2 codes. [Optional]
deviceType Array<number> [Optional]
adType Array<number> [Optional]
subid string [Optional] [Defaults to undefined]
filterBidType number Only this bid type. [Optional] [Defaults to undefined]

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Rows. -
401 Missing or invalid API key. -
403 Key lacks the required scope, or IP not in allowlist, or account suspended. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1PublisherSspStatsFiltersGet

apiV1PublisherSspStatsFiltersGet()

Filter values for the SSP reports.

Example

import {
  Configuration,
  StatsPublisherSSPApi,
} from 'goadserver-sdk';
import type { ApiV1PublisherSspStatsFiltersGetRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new StatsPublisherSSPApi(config);

  try {
    const data = await api.apiV1PublisherSspStatsFiltersGet();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

This endpoint does not need any parameter.

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 `{id, name}` lists for the filter parameters. -
401 Missing or invalid API key. -
403 Key lacks the required scope, or IP not in allowlist, or account suspended. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1PublisherSspStatsFlatGet

apiV1PublisherSspStatsFlatGet(from, to, group, viewtype, ssptype, campaignid, networkid, siteid, country, deviceType, adType, subid, filterBidType)

SSP report grouped by several dimensions.

The panel&#39;s flat SSP table. `group` is a comma-separated list of `date`, `campaign`, `country`, `website`, `adzone`, `subid`, `domainid`, `bid_type`, `bid_advid`, `bid_cid`, `bid_adid`, `mxispid` (default `date`); each row carries the grouped values plus `<dim>_name` where a name exists, and `startdate`/`enddate` for the row&#39;s period. `viewtype` sets the date bucket. At most 10,000 rows. Same filters and money units as `stats/details` (currency units, not cents). `totals` sums the whole result.

Example

import {
  Configuration,
  StatsPublisherSSPApi,
} from 'goadserver-sdk';
import type { ApiV1PublisherSspStatsFlatGetRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new StatsPublisherSSPApi(config);

  const body = {
    // Date (optional)
    from: 2013-10-20,
    // Date (optional)
    to: 2013-10-20,
    // string (optional)
    group: date,campaign,
    // 'day' | 'week' | 'month' | 'year' | 'sum' (optional)
    viewtype: viewtype_example,
    // 'ssp' | 'external' | 'exchange' (optional)
    ssptype: ssptype_example,
    // Array<number> (optional)
    campaignid: ...,
    // Array<number> (optional)
    networkid: ...,
    // Array<number> (optional)
    siteid: ...,
    // Array<string> (optional)
    country: ...,
    // Array<number> (optional)
    deviceType: ...,
    // Array<number> (optional)
    adType: ...,
    // string (optional)
    subid: subid_example,
    // number (optional)
    filterBidType: 56,
  } satisfies ApiV1PublisherSspStatsFlatGetRequest;

  try {
    const data = await api.apiV1PublisherSspStatsFlatGet(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
from Date [Optional] [Defaults to undefined]
to Date [Optional] [Defaults to undefined]
group string [Optional] [Defaults to &#39;date&#39;]
viewtype day, week, month, year, sum [Optional] [Defaults to &#39;day&#39;] [Enum: day, week, month, year, sum]
ssptype ssp, external, exchange [Optional] [Defaults to undefined] [Enum: ssp, external, exchange]
campaignid Array<number> [Optional]
networkid Array<number> [Optional]
siteid Array<number> [Optional]
country Array<string> [Optional]
deviceType Array<number> [Optional]
adType Array<number> [Optional]
subid string [Optional] [Defaults to undefined]
filterBidType number [Optional] [Defaults to undefined]

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Rows + totals. -
401 Missing or invalid API key. -
403 Key lacks the required scope, or IP not in allowlist, or account suspended. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1PublisherSspStatsGet

StatsResponse apiV1PublisherSspStatsGet(from, to, interval, groupBy, metrics, filterFeedId, filterCampaignId, filterSsptype, filterCountry, filterDevice, filterAdType, filterNetworkId, filterAdzoneId, filterWebsite, format, page, perPage, sort)

SSP / smart-campaign earnings.

SSP / smart-campaign earnings. Scoping (priority order): 1. `filter[feed_id]` — the SSP feed hash from the campaign row (the public identifier you give to ad networks). Limits results to one campaign without exposing the internal numeric ID. 2. `filter[campaign_id]` — internal numeric ID. 3. (default) every SSP campaign owned by the caller, optionally narrowed with `filter[ssptype]`. Authentication — this endpoint accepts two credentials. Either an account API key with the `stats.read` scope in the `Authorization` header, as everywhere else on this API, or the feed hash itself in `filter[feed_id]` (`token` is accepted as an alias, matching the legacy `/apitool/ssp_stats/` URL). The feed hash authenticates nothing but this report for that one feed, which is what makes the URL safe to hand to an ad network; an account key covers every feed on the account. When an `Authorization` header is present it is always used, so an invalid key is reported as such rather than falling back to the feed hash.

Example

import {
  Configuration,
  StatsPublisherSSPApi,
} from 'goadserver-sdk';
import type { ApiV1PublisherSspStatsGetRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new StatsPublisherSSPApi(config);

  const body = {
    // Date | ISO date — inclusive start. Defaults to 7 days ago. (optional)
    from: 2013-10-20,
    // Date | ISO date — inclusive end. Defaults to today. Max range 92 days. (optional)
    to: 2013-10-20,
    // 'day' | 'hour' | 'week' | 'month' | 'sum' (optional)
    interval: interval_example,
    // Array<'campaign' | 'country' | 'website' | 'adzone' | 'network'> | Dimensions to aggregate by. Multi-pick up to 8. (optional)
    groupBy: ["campaign","country"],
    // Array<'requests' | 'wins' | 'views' | 'clicks' | 'ctr' | 'ecpm' | 'earned' | 'errors'> | Metrics to return. Multi-pick — leave empty for all. (optional)
    metrics: ...,
    // string | SSP campaign feed hash (the public identifier given to ad networks). Pins results to one SSP campaign without exposing the internal numeric ID.  (optional)
    filterFeedId: filterFeedId_example,
    // number | Campaign ID. Look up via `GET /api/v1/campaigns`. (optional)
    filterCampaignId: 56,
    // string | SSP feed type filter. (optional)
    filterSsptype: filterSsptype_example,
    // string | ISO-3166 alpha-2 country code (e.g. `US`, `DE`, `BR`). (optional)
    filterCountry: US,
    // 1 | 2 | 3 | 4 | 5 | 6 | Device type:  | ID | Device | |----|--------| | 1  | Computer | | 2  | Tablet | | 3  | Phone | | 4  | Console | | 5  | Wearable | | 6  | TV |  (optional)
    filterDevice: 56,
    // number | Ad-type ID. Available types are tenant-specific (banner, popunder, native, video, push, …); the dropdown shows the types active on your system.  (optional)
    filterAdType: 56,
    // number | RTB network ID. (optional)
    filterNetworkId: 56,
    // number | One adspace id — look up via `GET /api/v1/adspaces`. (optional)
    filterAdzoneId: 56,
    // number | Site ID — look up via `GET /api/v1/sites`. (optional)
    filterWebsite: 56,
    // 'json' | 'csv' (optional)
    format: format_example,
    // number (optional)
    page: 56,
    // number (optional)
    perPage: 56,
    // string | Field name. Prefix with `-` for descending (e.g. `-views`). (optional)
    sort: sort_example,
  } satisfies ApiV1PublisherSspStatsGetRequest;

  try {
    const data = await api.apiV1PublisherSspStatsGet(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
from Date ISO date — inclusive start. Defaults to 7 days ago. [Optional] [Defaults to undefined]
to Date ISO date — inclusive end. Defaults to today. Max range 92 days. [Optional] [Defaults to undefined]
interval day, hour, week, month, sum [Optional] [Defaults to &#39;sum&#39;] [Enum: day, hour, week, month, sum]
groupBy campaign, country, website, adzone, network Dimensions to aggregate by. Multi-pick up to 8. [Optional] [Enum: campaign, country, website, adzone, network]
metrics requests, wins, views, clicks, ctr, ecpm, earned, errors Metrics to return. Multi-pick — leave empty for all. [Optional] [Enum: requests, wins, views, clicks, ctr, ecpm, earned, errors]
filterFeedId string SSP campaign feed hash (the public identifier given to ad networks). Pins results to one SSP campaign without exposing the internal numeric ID. [Optional] [Defaults to undefined]
filterCampaignId number Campaign ID. Look up via `GET /api/v1/campaigns`. [Optional] [Defaults to undefined]
filterSsptype string SSP feed type filter. [Optional] [Defaults to undefined]
filterCountry string ISO-3166 alpha-2 country code (e.g. `US`, `DE`, `BR`). [Optional] [Defaults to undefined]
filterDevice 1, 2, 3, 4, 5, 6 Device type: ID
filterAdType number Ad-type ID. Available types are tenant-specific (banner, popunder, native, video, push, …); the dropdown shows the types active on your system. [Optional] [Defaults to undefined]
filterNetworkId number RTB network ID. [Optional] [Defaults to undefined]
filterAdzoneId number One adspace id — look up via `GET /api/v1/adspaces`. [Optional] [Defaults to undefined]
filterWebsite number Site ID — look up via `GET /api/v1/sites`. [Optional] [Defaults to undefined]
format json, csv [Optional] [Defaults to &#39;json&#39;] [Enum: json, csv]
page number [Optional] [Defaults to 1]
perPage number [Optional] [Defaults to 100]
sort string Field name. Prefix with `-` for descending (e.g. `-views`). [Optional] [Defaults to undefined]

Return type

StatsResponse

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Stats response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]