Skip to content

StatsPublisherSmartZonesApi.md

Latest commit

 

History

History
194 lines (139 loc) · 8.96 KB

StatsPublisherSmartZonesApi.md

File metadata and controls

194 lines (139 loc) · 8.96 KB
Raw

goadserver.StatsPublisherSmartZonesApi

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

Method HTTP request Description
api_v1_publisher_smartzones_stats_filters_get GET /api/v1/publisher/smartzones/stats/filters Filter values for smart-zone stats.
api_v1_publisher_smartzones_stats_get GET /api/v1/publisher/smartzones/stats SmartZone (waterfall) earnings.

api_v1_publisher_smartzones_stats_filters_get

api_v1_publisher_smartzones_stats_filters_get()

Filter values for smart-zone stats.

Your websites, ad zones and smart network accounts, as {id, name} lists for the filter[…] parameters of GET /api/v1/publisher/smartzones/stats.

Example

  • Bearer (gas_live_<32 chars>) Authentication (apiKey):
import goadserver
from goadserver.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://up.go-adserver.com
# See configuration.py for a list of all supported configuration parameters.
configuration = goadserver.Configuration(
    host = "https://up.go-adserver.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (gas_live_<32 chars>): apiKey
configuration = goadserver.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with goadserver.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = goadserver.StatsPublisherSmartZonesApi(api_client)

    try:
        # Filter values for smart-zone stats.
        api_instance.api_v1_publisher_smartzones_stats_filters_get()
    except Exception as e:
        print("Exception when calling StatsPublisherSmartZonesApi->api_v1_publisher_smartzones_stats_filters_get: %s\n" % e)

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 Filter values. -
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]

api_v1_publisher_smartzones_stats_get

StatsResponse api_v1_publisher_smartzones_stats_get(var_from=var_from, to=to, interval=interval, group_by=group_by, metrics=metrics, filter_website=filter_website, filter_adzone_id=filter_adzone_id, filter_ad_type=filter_ad_type, filter_device=filter_device, filter_country=filter_country, filter_smart_network_id=filter_smart_network_id, format=format, page=page, per_page=per_page, sort=sort)

SmartZone (waterfall) earnings.

SmartZone (waterfall) earnings.

SmartZone earnings are recorded per day, so interval=hour is not supported on this endpoint and returns a validation error. The other intervals (day, week, month, sum) all apply.

Example

  • Bearer (gas_live_<32 chars>) Authentication (apiKey):
import goadserver
from goadserver.models.stats_response import StatsResponse
from goadserver.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://up.go-adserver.com
# See configuration.py for a list of all supported configuration parameters.
configuration = goadserver.Configuration(
    host = "https://up.go-adserver.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (gas_live_<32 chars>): apiKey
configuration = goadserver.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with goadserver.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = goadserver.StatsPublisherSmartZonesApi(api_client)
    var_from = '2013-10-20' # date | ISO date — inclusive start. Defaults to 7 days ago. (optional)
    to = '2013-10-20' # date | ISO date — inclusive end. Defaults to today. Max range 92 days. (optional)
    interval = sum # str |  (optional) (default to sum)
    group_by = ['[\"website\",\"adzone\"]'] # List[str] | Dimensions to aggregate by. Multi-pick up to 8. (optional)
    metrics = ['metrics_example'] # List[str] | Metrics to return. Multi-pick — leave empty for all. (optional)
    filter_website = 56 # int | Site ID — look up via `GET /api/v1/sites`. (optional)
    filter_adzone_id = '12345,12346' # str | Adspace ID, or comma-separated list. Look up via `GET /api/v1/adspaces`. (optional)
    filter_ad_type = 56 # int | Ad-type ID. Available types are tenant-specific (banner, popunder, native, video, push, …); the dropdown shows the types active on your system.  (optional)
    filter_device = 56 # int | Device type:  | ID | Device | |----|--------| | 1  | Computer | | 2  | Tablet | | 3  | Phone | | 4  | Console | | 5  | Wearable | | 6  | TV |  (optional)
    filter_country = 'US' # str | ISO-3166 alpha-2 country code (e.g. `US`, `DE`, `BR`). (optional)
    filter_smart_network_id = 56 # int | SmartZone network ID. (optional)
    format = json # str |  (optional) (default to json)
    page = 1 # int |  (optional) (default to 1)
    per_page = 100 # int |  (optional) (default to 100)
    sort = 'sort_example' # str | Field name. Prefix with `-` for descending (e.g. `-views`). (optional)

    try:
        # SmartZone (waterfall) earnings.
        api_response = api_instance.api_v1_publisher_smartzones_stats_get(var_from=var_from, to=to, interval=interval, group_by=group_by, metrics=metrics, filter_website=filter_website, filter_adzone_id=filter_adzone_id, filter_ad_type=filter_ad_type, filter_device=filter_device, filter_country=filter_country, filter_smart_network_id=filter_smart_network_id, format=format, page=page, per_page=per_page, sort=sort)
        print("The response of StatsPublisherSmartZonesApi->api_v1_publisher_smartzones_stats_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StatsPublisherSmartZonesApi->api_v1_publisher_smartzones_stats_get: %s\n" % e)

Parameters

Name Type Description Notes
var_from date ISO date — inclusive start. Defaults to 7 days ago. [optional]
to date ISO date — inclusive end. Defaults to today. Max range 92 days. [optional]
interval str [optional] [default to sum]
group_by List[str] Dimensions to aggregate by. Multi-pick up to 8. [optional]
metrics List[str] Metrics to return. Multi-pick — leave empty for all. [optional]
filter_website int Site ID — look up via `GET /api/v1/sites`. [optional]
filter_adzone_id str Adspace ID, or comma-separated list. Look up via `GET /api/v1/adspaces`. [optional]
filter_ad_type int Ad-type ID. Available types are tenant-specific (banner, popunder, native, video, push, …); the dropdown shows the types active on your system. [optional]
filter_device int Device type: ID
filter_country str ISO-3166 alpha-2 country code (e.g. `US`, `DE`, `BR`). [optional]
filter_smart_network_id int SmartZone network ID. [optional]
format str [optional] [default to json]
page int [optional] [default to 1]
per_page int [optional] [default to 100]
sort str Field name. Prefix with `-` for descending (e.g. `-views`). [optional]

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]