\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(ctx).From(from).To(to).Type_(type_).Ssptype(ssptype).Campaignid(campaignid).Networkid(networkid).Siteid(siteid).Country(country).DeviceType(deviceType).AdType(adType).Subid(subid).FilterBidType(filterBidType).Execute()

SSP report broken down by one dimension.

Example

package main

import (
	"context"
	"fmt"
	"os"
    "time"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	from := time.Now() // string | Inclusive start. Defaults to 6 days ago (send both from and to). (optional)
	to := time.Now() // string |  (optional)
	type_ := "type__example" // string |  (optional) (default to "campaign")
	ssptype := "ssptype_example" // string |  (optional)
	campaignid := []int32{int32(123)} // []int32 | One or more SSP campaign ids (`campaignid=1&campaignid=2` or `campaignid[]=…`). (optional)
	networkid := []int32{int32(123)} // []int32 |  (optional)
	siteid := []int32{int32(123)} // []int32 |  (optional)
	country := []string{"Inner_example"} // []string | ISO-3166 alpha-2 codes. (optional)
	deviceType := []int32{int32(123)} // []int32 |  (optional)
	adType := []int32{int32(123)} // []int32 |  (optional)
	subid := "subid_example" // string |  (optional)
	filterBidType := int32(56) // int32 | Only this bid type. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.StatsPublisherSSPAPI.ApiV1PublisherSspStatsDetailsGet(context.Background()).From(from).To(to).Type_(type_).Ssptype(ssptype).Campaignid(campaignid).Networkid(networkid).Siteid(siteid).Country(country).DeviceType(deviceType).AdType(adType).Subid(subid).FilterBidType(filterBidType).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StatsPublisherSSPAPI.ApiV1PublisherSspStatsDetailsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1PublisherSspStatsDetailsGetRequest struct via the builder pattern

Name	Type	Description	Notes
from	string	Inclusive start. Defaults to 6 days ago (send both from and to).
to	string
type_	string		[default to "campaign"]
ssptype	string
campaignid	[]int32	One or more SSP campaign ids (`campaignid=1&campaignid=2` or `campaignid[]=…`).
networkid	[]int32
siteid	[]int32
country	[]string	ISO-3166 alpha-2 codes.
deviceType	[]int32
adType	[]int32
subid	string
filterBidType	int32	Only this bid type.

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ApiV1PublisherSspStatsFiltersGet

ApiV1PublisherSspStatsFiltersGet(ctx).Execute()

Filter values for the SSP reports.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.StatsPublisherSSPAPI.ApiV1PublisherSspStatsFiltersGet(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StatsPublisherSSPAPI.ApiV1PublisherSspStatsFiltersGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiApiV1PublisherSspStatsFiltersGetRequest struct via the builder pattern

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ApiV1PublisherSspStatsFlatGet

ApiV1PublisherSspStatsFlatGet(ctx).From(from).To(to).Group(group).Viewtype(viewtype).Ssptype(ssptype).Campaignid(campaignid).Networkid(networkid).Siteid(siteid).Country(country).DeviceType(deviceType).AdType(adType).Subid(subid).FilterBidType(filterBidType).Execute()

SSP report grouped by several dimensions.

Example

package main

import (
	"context"
	"fmt"
	"os"
    "time"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	from := time.Now() // string |  (optional)
	to := time.Now() // string |  (optional)
	group := "date,campaign" // string |  (optional) (default to "date")
	viewtype := "viewtype_example" // string |  (optional) (default to "day")
	ssptype := "ssptype_example" // string |  (optional)
	campaignid := []int32{int32(123)} // []int32 |  (optional)
	networkid := []int32{int32(123)} // []int32 |  (optional)
	siteid := []int32{int32(123)} // []int32 |  (optional)
	country := []string{"Inner_example"} // []string |  (optional)
	deviceType := []int32{int32(123)} // []int32 |  (optional)
	adType := []int32{int32(123)} // []int32 |  (optional)
	subid := "subid_example" // string |  (optional)
	filterBidType := int32(56) // int32 |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.StatsPublisherSSPAPI.ApiV1PublisherSspStatsFlatGet(context.Background()).From(from).To(to).Group(group).Viewtype(viewtype).Ssptype(ssptype).Campaignid(campaignid).Networkid(networkid).Siteid(siteid).Country(country).DeviceType(deviceType).AdType(adType).Subid(subid).FilterBidType(filterBidType).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StatsPublisherSSPAPI.ApiV1PublisherSspStatsFlatGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1PublisherSspStatsFlatGetRequest struct via the builder pattern

Name	Type	Notes
from	string
to	string
group	string	[default to "date"]
viewtype	string	[default to "day"]
ssptype	string
campaignid	[]int32
networkid	[]int32
siteid	[]int32
country	[]string
deviceType	[]int32
adType	[]int32
subid	string
filterBidType	int32

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ApiV1PublisherSspStatsGet

StatsResponse ApiV1PublisherSspStatsGet(ctx).From(from).To(to).Interval(interval).GroupBy(groupBy).Metrics(metrics).FilterFeedId(filterFeedId).FilterCampaignId(filterCampaignId).FilterSsptype(filterSsptype).FilterCountry(filterCountry).FilterDevice(filterDevice).FilterAdType(filterAdType).FilterNetworkId(filterNetworkId).FilterAdzoneId(filterAdzoneId).FilterWebsite(filterWebsite).Format(format).Page(page).PerPage(perPage).Sort(sort).Execute()

SSP / smart-campaign earnings.

Example

package main

import (
	"context"
	"fmt"
	"os"
    "time"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	from := time.Now() // string | ISO date — inclusive start. Defaults to 7 days ago. (optional)
	to := time.Now() // string | ISO date — inclusive end. Defaults to today. Max range 92 days. (optional)
	interval := "interval_example" // string |  (optional) (default to "sum")
	groupBy := []string{"GroupBy_example"} // []string | Dimensions to aggregate by. Multi-pick up to 8. (optional)
	metrics := []string{"Metrics_example"} // []string | Metrics to return. Multi-pick — leave empty for all. (optional)
	filterFeedId := "filterFeedId_example" // 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)
	filterCampaignId := int32(56) // int32 | Campaign ID. Look up via `GET /api/v1/campaigns`. (optional)
	filterSsptype := "filterSsptype_example" // string | SSP feed type filter. (optional)
	filterCountry := "US" // string | ISO-3166 alpha-2 country code (e.g. `US`, `DE`, `BR`). (optional)
	filterDevice := int32(56) // int32 | Device type:  | ID | Device | |----|--------| | 1  | Computer | | 2  | Tablet | | 3  | Phone | | 4  | Console | | 5  | Wearable | | 6  | TV |  (optional)
	filterAdType := int32(56) // int32 | Ad-type ID. Available types are tenant-specific (banner, popunder, native, video, push, …); the dropdown shows the types active on your system.  (optional)
	filterNetworkId := int32(56) // int32 | RTB network ID. (optional)
	filterAdzoneId := int32(56) // int32 | One adspace id — look up via `GET /api/v1/adspaces`. (optional)
	filterWebsite := int32(56) // int32 | Site ID — look up via `GET /api/v1/sites`. (optional)
	format := "format_example" // string |  (optional) (default to "json")
	page := int32(56) // int32 |  (optional) (default to 1)
	perPage := int32(56) // int32 |  (optional) (default to 100)
	sort := "sort_example" // string | Field name. Prefix with `-` for descending (e.g. `-views`). (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.StatsPublisherSSPAPI.ApiV1PublisherSspStatsGet(context.Background()).From(from).To(to).Interval(interval).GroupBy(groupBy).Metrics(metrics).FilterFeedId(filterFeedId).FilterCampaignId(filterCampaignId).FilterSsptype(filterSsptype).FilterCountry(filterCountry).FilterDevice(filterDevice).FilterAdType(filterAdType).FilterNetworkId(filterNetworkId).FilterAdzoneId(filterAdzoneId).FilterWebsite(filterWebsite).Format(format).Page(page).PerPage(perPage).Sort(sort).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `StatsPublisherSSPAPI.ApiV1PublisherSspStatsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1PublisherSspStatsGet`: StatsResponse
	fmt.Fprintf(os.Stdout, "Response from `StatsPublisherSSPAPI.ApiV1PublisherSspStatsGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1PublisherSspStatsGetRequest struct via the builder pattern

Name	Type	Description	Notes
from	string	ISO date — inclusive start. Defaults to 7 days ago.
to	string	ISO date — inclusive end. Defaults to today. Max range 92 days.
interval	string		[default to "sum"]
groupBy	[]string	Dimensions to aggregate by. Multi-pick up to 8.
metrics	[]string	Metrics to return. Multi-pick — leave empty for all.
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.
filterCampaignId	int32	Campaign ID. Look up via `GET /api/v1/campaigns`.
filterSsptype	string	SSP feed type filter.
filterCountry	string	ISO-3166 alpha-2 country code (e.g. `US`, `DE`, `BR`).
filterDevice	int32	Device type:	ID
filterAdType	int32	Ad-type ID. Available types are tenant-specific (banner, popunder, native, video, push, …); the dropdown shows the types active on your system.
filterNetworkId	int32	RTB network ID.
filterAdzoneId	int32	One adspace id — look up via `GET /api/v1/adspaces`.
filterWebsite	int32	Site ID — look up via `GET /api/v1/sites`.
format	string		[default to "json"]
page	int32		[default to 1]
perPage	int32		[default to 100]
sort	string	Field name. Prefix with `-` for descending (e.g. `-views`).

Return type

StatsResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Navigation Menu

Repository navigation

StatsPublisherSSPAPI.md

StatsPublisherSSPAPI.md

\StatsPublisherSSPAPI

ApiV1PublisherSspStatsDetailsGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1PublisherSspStatsFiltersGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1PublisherSspStatsFlatGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1PublisherSspStatsGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

FilesExpand file tree

StatsPublisherSSPAPI.md

Latest commit

History

StatsPublisherSSPAPI.md

File metadata and controls

\StatsPublisherSSPAPI

ApiV1PublisherSspStatsDetailsGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1PublisherSspStatsFiltersGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1PublisherSspStatsFlatGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ApiV1PublisherSspStatsGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers