Skip to content

EventLogAPI.md

Latest commit

 

History

History
286 lines (187 loc) · 8.06 KB

EventLogAPI.md

File metadata and controls

286 lines (187 loc) · 8.06 KB
Raw

\EventLogAPI

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

Method HTTP request Description
ApiV1EventLogExportsGet Get /api/v1/event-log/exports Your event log exports, newest first.
ApiV1EventLogExportsIdDownloadGet Get /api/v1/event-log/exports/{id}/download Download a finished export (.csv.gz).
ApiV1EventLogExportsPost Post /api/v1/event-log/exports Queue a CSV export of your events.
ApiV1EventLogGet Get /api/v1/event-log Your raw events — impressions and clicks with IP and user agent (90 days).

ApiV1EventLogExportsGet

ApiV1EventLogExportsGet(ctx).Execute()

Your event log exports, newest first.

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.EventLogAPI.ApiV1EventLogExportsGet(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EventLogAPI.ApiV1EventLogExportsGet``: %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 apiApiV1EventLogExportsGetRequest 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]

ApiV1EventLogExportsIdDownloadGet

ApiV1EventLogExportsIdDownloadGet(ctx, id).Execute()

Download a finished export (.csv.gz).

Example

package main

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

func main() {
	id := int32(56) // int32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

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

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

ApiV1EventLogExportsPost

ApiV1EventLogExportsPost(ctx).ApiV1EventLogExportsPostRequest(apiV1EventLogExportsPostRequest).Execute()

Queue a CSV export of your events.

Example

package main

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

func main() {
	apiV1EventLogExportsPostRequest := *openapiclient.NewApiV1EventLogExportsPostRequest() // ApiV1EventLogExportsPostRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.EventLogAPI.ApiV1EventLogExportsPost(context.Background()).ApiV1EventLogExportsPostRequest(apiV1EventLogExportsPostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EventLogAPI.ApiV1EventLogExportsPost``: %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 apiApiV1EventLogExportsPostRequest struct via the builder pattern

Name Type Description Notes
apiV1EventLogExportsPostRequest ApiV1EventLogExportsPostRequest

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

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

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

ApiV1EventLogGet

ApiV1EventLogGet(ctx).DateFrom(dateFrom).DateTo(dateTo).Side(side).CampaignId(campaignId).AdId(adId).SiteId(siteId).ZoneId(zoneId).Event(event).Country(country).Ip(ip).Page(page).PerPage(perPage).Execute()

Your raw events — impressions and clicks with IP and user agent (90 days).

Example

package main

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

func main() {
	dateFrom := time.Now() // string | First day (YYYY-MM-DD, network timezone). Default date_to. Events are kept 90 days; older dates are a 422. (optional)
	dateTo := time.Now() // string | Last day. Default today. (optional)
	side := "side_example" // string | Only events where the account is the advertiser, or the publisher. Omit for both. (optional)
	campaignId := int32(56) // int32 |  (optional)
	adId := int32(56) // int32 |  (optional)
	siteId := int32(56) // int32 |  (optional)
	zoneId := int32(56) // int32 |  (optional)
	event := "event_example" // string |  (optional)
	country := "NL" // string | Two-letter country code. (optional)
	ip := "ip_example" // string | Exact visitor IP. (optional)
	page := int32(56) // int32 |  (optional) (default to 1)
	perPage := int32(56) // int32 |  (optional) (default to 50)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.EventLogAPI.ApiV1EventLogGet(context.Background()).DateFrom(dateFrom).DateTo(dateTo).Side(side).CampaignId(campaignId).AdId(adId).SiteId(siteId).ZoneId(zoneId).Event(event).Country(country).Ip(ip).Page(page).PerPage(perPage).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EventLogAPI.ApiV1EventLogGet``: %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 apiApiV1EventLogGetRequest struct via the builder pattern

Name Type Description Notes
dateFrom string First day (YYYY-MM-DD, network timezone). Default date_to. Events are kept 90 days; older dates are a 422.
dateTo string Last day. Default today.
side string Only events where the account is the advertiser, or the publisher. Omit for both.
campaignId int32
adId int32
siteId int32
zoneId int32
event string
country string Two-letter country code.
ip string Exact visitor IP.
page int32 [default to 1]
perPage int32 [default to 50]

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]