goadserver.TrackingApi

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

Method	HTTP request	Description
api_v1_tracking_conversion_types_get	GET /api/v1/tracking/conversion-types	Available conversion types for the caller's account.
api_v1_tracking_conversion_types_put	PUT /api/v1/tracking/conversion-types	Name conversion-type slots and set the click-id dedup opt-outs.
api_v1_tracking_pixels_get	GET /api/v1/tracking/pixels	Deprecated: List the caller's conversion-tracking pixels.
api_v1_tracking_pixels_id_delete	DELETE /api/v1/tracking/pixels/{id}	Deprecated: Delete a pixel.
api_v1_tracking_pixels_id_get	GET /api/v1/tracking/pixels/{id}	Deprecated: Get one pixel.
api_v1_tracking_pixels_id_put	PUT /api/v1/tracking/pixels/{id}	Deprecated: Update a pixel's name or conversion type.
api_v1_tracking_pixels_post	POST /api/v1/tracking/pixels	Deprecated: Create a new tracking pixel.

api_v1_tracking_conversion_types_get

ApiV1TrackingConversionTypesGet200Response api_v1_tracking_conversion_types_get()

Available conversion types for the caller's account.

The account's named conversion-type slots (0–25, sorted A–Z by name; unnamed slots are omitted), the slots opted out of click-id deduplication, the network's ad-domain and the configured tracking variable name (needed to construct the postback URL). id is the slot a postback's conversion type refers to. An account that has never saved its conversion types gets the defaults (0 = Sign ups, 1 = Conversions, 25 = Refunds) — the same names the first PUT seeds; an account that switched every slot off gets []. Same handler as the panel. Requires the tenant's tracking module (modules.advertiser.tracking).

Example

Bearer (gas_live_<32 chars>) Authentication (apiKey):

import goadserver
from goadserver.models.api_v1_tracking_conversion_types_get200_response import ApiV1TrackingConversionTypesGet200Response
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.TrackingApi(api_client)

    try:
        # Available conversion types for the caller's account.
        api_response = api_instance.api_v1_tracking_conversion_types_get()
        print("The response of TrackingApi->api_v1_tracking_conversion_types_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TrackingApi->api_v1_tracking_conversion_types_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ApiV1TrackingConversionTypesGet200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Conversion types + tracking config	-

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

api_v1_tracking_conversion_types_put

ApiV1TrackingConversionTypesPut200Response api_v1_tracking_conversion_types_put(api_v1_tracking_conversion_types_put_request)

Name conversion-type slots and set the click-id dedup opt-outs.

Same handler as the panel's Tracking page. Send either types: [{id, name}] or conv_type_0..conv_type_25 keys to name slots (an empty name clears the slot; HTML tags are stripped), and/or skip_dedup: [slot ids] to replace the set of slots excluded from click-id deduplication (an empty array clears it). Slots outside 0–25 are ignored. Fields you don't send are left alone. Unknown keys are a 422 for API callers. The first save creates the account's row with the defaults Sign ups (0), Conversions (1), Refunds (25).

Example

Bearer (gas_live_<32 chars>) Authentication (apiKey):

import goadserver
from goadserver.models.api_v1_tracking_conversion_types_put200_response import ApiV1TrackingConversionTypesPut200Response
from goadserver.models.api_v1_tracking_conversion_types_put_request import ApiV1TrackingConversionTypesPutRequest
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.TrackingApi(api_client)
    api_v1_tracking_conversion_types_put_request = {"types":[{"id":2,"name":"Deposit"},{"id":3,"name":"Rebill"}],"skip_dedup":[3]} # ApiV1TrackingConversionTypesPutRequest | 

    try:
        # Name conversion-type slots and set the click-id dedup opt-outs.
        api_response = api_instance.api_v1_tracking_conversion_types_put(api_v1_tracking_conversion_types_put_request)
        print("The response of TrackingApi->api_v1_tracking_conversion_types_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TrackingApi->api_v1_tracking_conversion_types_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
api_v1_tracking_conversion_types_put_request	ApiV1TrackingConversionTypesPutRequest

Return type

ApiV1TrackingConversionTypesPut200Response

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Saved	-
400	No conversion types provided (`no_fields`).	-
403	Key lacks the required scope, or IP not in allowlist, or account suspended.	-
422	Unknown field.	-

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

api_v1_tracking_pixels_get

ApiV1TrackingPixelsGet200Response api_v1_tracking_pixels_get(conversion_type_id=conversion_type_id, name=name, page=page, per_page=per_page)

Deprecated: List the caller's conversion-tracking pixels.

Example

Bearer (gas_live_<32 chars>) Authentication (apiKey):

import goadserver
from goadserver.models.api_v1_tracking_pixels_get200_response import ApiV1TrackingPixelsGet200Response
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.TrackingApi(api_client)
    conversion_type_id = 56 # int | Filter by conversion type. (optional)
    name = 'name_example' # str | Substring search on name. (optional)
    page = 1 # int |  (optional) (default to 1)
    per_page = 100 # int |  (optional) (default to 100)

    try:
        # Deprecated: List the caller's conversion-tracking pixels.
        api_response = api_instance.api_v1_tracking_pixels_get(conversion_type_id=conversion_type_id, name=name, page=page, per_page=per_page)
        print("The response of TrackingApi->api_v1_tracking_pixels_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TrackingApi->api_v1_tracking_pixels_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
conversion_type_id	int	Filter by conversion type.	[optional]
name	str	Substring search on name.	[optional]
page	int		[optional] [default to 1]
per_page	int		[optional] [default to 100]

Return type

ApiV1TrackingPixelsGet200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Pixel list	-

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

api_v1_tracking_pixels_id_delete

api_v1_tracking_pixels_id_delete(id)

Deprecated: Delete a pixel.

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.TrackingApi(api_client)
    id = 56 # int | 

    try:
        # Deprecated: Delete a pixel.
        api_instance.api_v1_tracking_pixels_id_delete(id)
    except Exception as e:
        print("Exception when calling TrackingApi->api_v1_tracking_pixels_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

void (empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Deleted	-
404	Not found	-

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

api_v1_tracking_pixels_id_get

TrackingPixel api_v1_tracking_pixels_id_get(id)

Deprecated: Get one pixel.

Example

Bearer (gas_live_<32 chars>) Authentication (apiKey):

import goadserver
from goadserver.models.tracking_pixel import TrackingPixel
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.TrackingApi(api_client)
    id = 56 # int | 

    try:
        # Deprecated: Get one pixel.
        api_response = api_instance.api_v1_tracking_pixels_id_get(id)
        print("The response of TrackingApi->api_v1_tracking_pixels_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TrackingApi->api_v1_tracking_pixels_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

TrackingPixel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Pixel	-
404	Not found	-

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

api_v1_tracking_pixels_id_put

TrackingPixel api_v1_tracking_pixels_id_put(id, api_v1_tracking_pixels_id_put_request)

Deprecated: Update a pixel's name or conversion type.

Example

Bearer (gas_live_<32 chars>) Authentication (apiKey):

import goadserver
from goadserver.models.api_v1_tracking_pixels_id_put_request import ApiV1TrackingPixelsIdPutRequest
from goadserver.models.tracking_pixel import TrackingPixel
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.TrackingApi(api_client)
    id = 56 # int | 
    api_v1_tracking_pixels_id_put_request = goadserver.ApiV1TrackingPixelsIdPutRequest() # ApiV1TrackingPixelsIdPutRequest | 

    try:
        # Deprecated: Update a pixel's name or conversion type.
        api_response = api_instance.api_v1_tracking_pixels_id_put(id, api_v1_tracking_pixels_id_put_request)
        print("The response of TrackingApi->api_v1_tracking_pixels_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TrackingApi->api_v1_tracking_pixels_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
api_v1_tracking_pixels_id_put_request	ApiV1TrackingPixelsIdPutRequest

Return type

TrackingPixel

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Updated	-
404	Not found	-

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

api_v1_tracking_pixels_post

TrackingPixel api_v1_tracking_pixels_post(api_v1_tracking_pixels_post_request)

Deprecated: Create a new tracking pixel.

Deprecated — the row is stored but nothing reads it. pixel_code is generated server-side (32 random hex chars) and returned in the response; putting it in a conversion URL has no effect. To track conversions, name a slot with PUT /api/v1/tracking/conversion-types and send postbacks with the click id and that slot.

Example

Bearer (gas_live_<32 chars>) Authentication (apiKey):

import goadserver
from goadserver.models.api_v1_tracking_pixels_post_request import ApiV1TrackingPixelsPostRequest
from goadserver.models.tracking_pixel import TrackingPixel
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.TrackingApi(api_client)
    api_v1_tracking_pixels_post_request = goadserver.ApiV1TrackingPixelsPostRequest() # ApiV1TrackingPixelsPostRequest | 

    try:
        # Deprecated: Create a new tracking pixel.
        api_response = api_instance.api_v1_tracking_pixels_post(api_v1_tracking_pixels_post_request)
        print("The response of TrackingApi->api_v1_tracking_pixels_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TrackingApi->api_v1_tracking_pixels_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
api_v1_tracking_pixels_post_request	ApiV1TrackingPixelsPostRequest

Return type

TrackingPixel

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
422	Validation error	-

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

FilesExpand file tree

TrackingApi.md

Latest commit

History

TrackingApi.md

File metadata and controls

goadserver.TrackingApi

api_v1_tracking_conversion_types_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v1_tracking_conversion_types_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v1_tracking_pixels_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v1_tracking_pixels_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v1_tracking_pixels_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v1_tracking_pixels_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v1_tracking_pixels_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details