Skip to content

Latest commit

 

History

History
555 lines (355 loc) · 17.9 KB

TrackerConversionsAPI.md

File metadata and controls

555 lines (355 loc) · 17.9 KB

\TrackerConversionsAPI

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

Method HTTP request Description
ApiV1TrackerConversionLoggingGet Get /api/v1/tracker/conversion-logging Get conversion-logging settings.
ApiV1TrackerConversionLoggingPut Put /api/v1/tracker/conversion-logging Change conversion-logging settings.
ApiV1TrackerConversionTypesGet Get /api/v1/tracker/conversion-types Get the conversion-type labels.
ApiV1TrackerConversionTypesPut Put /api/v1/tracker/conversion-types Rename the conversion types.
ApiV1TrackerConversionsClickidPostbacksGet Get /api/v1/tracker/conversions/{clickid}/postbacks Outbound postbacks fired for one conversion.
ApiV1TrackerConversionsGet Get /api/v1/tracker/conversions List incoming conversions.
ApiV1TrackerConversionsIdStatePut Put /api/v1/tracker/conversions/{id}/state Approve or reject one conversion.
ApiV1TrackerConversionsRejectedGet Get /api/v1/tracker/conversions/rejected List refused inbound postbacks.

ApiV1TrackerConversionLoggingGet

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1TrackerConversionLoggingGet(ctx).Execute()

Get conversion-logging settings.

Example

package main

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

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TrackerConversionsAPI.ApiV1TrackerConversionLoggingGet(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackerConversionsAPI.ApiV1TrackerConversionLoggingGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1TrackerConversionLoggingGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
	fmt.Fprintf(os.Stdout, "Response from `TrackerConversionsAPI.ApiV1TrackerConversionLoggingGet`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]

ApiV1TrackerConversionLoggingPut

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1TrackerConversionLoggingPut(ctx).ApiV1TrackerConversionLoggingPutRequest(apiV1TrackerConversionLoggingPutRequest).Execute()

Change conversion-logging settings.

Example

package main

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

func main() {
	apiV1TrackerConversionLoggingPutRequest := *openapiclient.NewApiV1TrackerConversionLoggingPutRequest() // ApiV1TrackerConversionLoggingPutRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TrackerConversionsAPI.ApiV1TrackerConversionLoggingPut(context.Background()).ApiV1TrackerConversionLoggingPutRequest(apiV1TrackerConversionLoggingPutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackerConversionsAPI.ApiV1TrackerConversionLoggingPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1TrackerConversionLoggingPut`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
	fmt.Fprintf(os.Stdout, "Response from `TrackerConversionsAPI.ApiV1TrackerConversionLoggingPut`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
apiV1TrackerConversionLoggingPutRequest ApiV1TrackerConversionLoggingPutRequest

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]

ApiV1TrackerConversionTypesGet

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1TrackerConversionTypesGet(ctx).Execute()

Get the conversion-type labels.

Example

package main

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

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TrackerConversionsAPI.ApiV1TrackerConversionTypesGet(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackerConversionsAPI.ApiV1TrackerConversionTypesGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1TrackerConversionTypesGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
	fmt.Fprintf(os.Stdout, "Response from `TrackerConversionsAPI.ApiV1TrackerConversionTypesGet`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]

ApiV1TrackerConversionTypesPut

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1TrackerConversionTypesPut(ctx).ApiV1TrackerConversionTypesPutRequest(apiV1TrackerConversionTypesPutRequest).Execute()

Rename the conversion types.

Example

package main

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

func main() {
	apiV1TrackerConversionTypesPutRequest := *openapiclient.NewApiV1TrackerConversionTypesPutRequest(map[string]string{"key": "Inner_example"}) // ApiV1TrackerConversionTypesPutRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TrackerConversionsAPI.ApiV1TrackerConversionTypesPut(context.Background()).ApiV1TrackerConversionTypesPutRequest(apiV1TrackerConversionTypesPutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackerConversionsAPI.ApiV1TrackerConversionTypesPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1TrackerConversionTypesPut`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
	fmt.Fprintf(os.Stdout, "Response from `TrackerConversionsAPI.ApiV1TrackerConversionTypesPut`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
apiV1TrackerConversionTypesPutRequest ApiV1TrackerConversionTypesPutRequest

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]

ApiV1TrackerConversionsClickidPostbacksGet

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1TrackerConversionsClickidPostbacksGet(ctx, clickid).ConvType(convType).Execute()

Outbound postbacks fired for one conversion.

Example

package main

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

func main() {
	clickid := "clickid_example" // string | The conversion's click id.
	convType := "convType_example" // string | Narrow to one conversion type letter. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TrackerConversionsAPI.ApiV1TrackerConversionsClickidPostbacksGet(context.Background(), clickid).ConvType(convType).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackerConversionsAPI.ApiV1TrackerConversionsClickidPostbacksGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1TrackerConversionsClickidPostbacksGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
	fmt.Fprintf(os.Stdout, "Response from `TrackerConversionsAPI.ApiV1TrackerConversionsClickidPostbacksGet`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
clickid string The conversion's click id.

Other Parameters

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

Name Type Description Notes

convType | string | Narrow to one conversion type letter. |

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]

ApiV1TrackerConversionsGet

ApiV1TrackerConversionsGet200Response ApiV1TrackerConversionsGet(ctx).StartDate(startDate).EndDate(endDate).State(state).ReasonId(reasonId).Search(search).SortBy(sortBy).SortDir(sortDir).Limit(limit).Execute()

List incoming conversions.

Example

package main

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

func main() {
	startDate := "startDate_example" // string | Start of the window, YYYY-MM-DD. (optional)
	endDate := "endDate_example" // string | End of the window, YYYY-MM-DD. (optional)
	state := int32(56) // int32 | Filter by settlement state. (optional)
	reasonId := int32(56) // int32 | Filter by hold/reject reason. (optional)
	search := "search_example" // string | Match against clickid, offer or link name. (optional)
	sortBy := "sortBy_example" // string | Column to sort on. (optional)
	sortDir := "sortDir_example" // string | asc or desc. (optional)
	limit := int32(56) // int32 | Maximum rows to return. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TrackerConversionsAPI.ApiV1TrackerConversionsGet(context.Background()).StartDate(startDate).EndDate(endDate).State(state).ReasonId(reasonId).Search(search).SortBy(sortBy).SortDir(sortDir).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackerConversionsAPI.ApiV1TrackerConversionsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1TrackerConversionsGet`: ApiV1TrackerConversionsGet200Response
	fmt.Fprintf(os.Stdout, "Response from `TrackerConversionsAPI.ApiV1TrackerConversionsGet`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
startDate string Start of the window, YYYY-MM-DD.
endDate string End of the window, YYYY-MM-DD.
state int32 Filter by settlement state.
reasonId int32 Filter by hold/reject reason.
search string Match against clickid, offer or link name.
sortBy string Column to sort on.
sortDir string asc or desc.
limit int32 Maximum rows to return.

Return type

ApiV1TrackerConversionsGet200Response

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]

ApiV1TrackerConversionsIdStatePut

ApiV1PublisherPushCampaignsPost200Response ApiV1TrackerConversionsIdStatePut(ctx, id).ApiV1TrackerConversionsIdStatePutRequest(apiV1TrackerConversionsIdStatePutRequest).Execute()

Approve or reject one conversion.

Example

package main

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

func main() {
	id := int32(56) // int32 | Conversion ID.
	apiV1TrackerConversionsIdStatePutRequest := *openapiclient.NewApiV1TrackerConversionsIdStatePutRequest(int32(123)) // ApiV1TrackerConversionsIdStatePutRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TrackerConversionsAPI.ApiV1TrackerConversionsIdStatePut(context.Background(), id).ApiV1TrackerConversionsIdStatePutRequest(apiV1TrackerConversionsIdStatePutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackerConversionsAPI.ApiV1TrackerConversionsIdStatePut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1TrackerConversionsIdStatePut`: ApiV1PublisherPushCampaignsPost200Response
	fmt.Fprintf(os.Stdout, "Response from `TrackerConversionsAPI.ApiV1TrackerConversionsIdStatePut`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

apiV1TrackerConversionsIdStatePutRequest | ApiV1TrackerConversionsIdStatePutRequest | |

Return type

ApiV1PublisherPushCampaignsPost200Response

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]

ApiV1TrackerConversionsRejectedGet

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response ApiV1TrackerConversionsRejectedGet(ctx).Execute()

List refused inbound postbacks.

Example

package main

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

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.TrackerConversionsAPI.ApiV1TrackerConversionsRejectedGet(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackerConversionsAPI.ApiV1TrackerConversionsRejectedGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ApiV1TrackerConversionsRejectedGet`: ApiV1TrackerTrackingLinksIdZoneCostsGet200Response
	fmt.Fprintf(os.Stdout, "Response from `TrackerConversionsAPI.ApiV1TrackerConversionsRejectedGet`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ApiV1TrackerTrackingLinksIdZoneCostsGet200Response

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]