goadserver.RetargetingApi

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

Method	HTTP request	Description
api_v1_retargeting_pixels_get	GET /api/v1/retargeting/pixels	List the caller's retargeting pixels.
api_v1_retargeting_pixels_id_active_patch	PATCH /api/v1/retargeting/pixels/{id}/active	Activate or deactivate a retargeting pixel.
api_v1_retargeting_pixels_id_delete	DELETE /api/v1/retargeting/pixels/{id}	Soft-delete a retargeting pixel and clear its captured visitors.
api_v1_retargeting_pixels_id_get	GET /api/v1/retargeting/pixels/{id}	Get one retargeting pixel.
api_v1_retargeting_pixels_id_put	PUT /api/v1/retargeting/pixels/{id}	Update a retargeting pixel (name and visitor windows).
api_v1_retargeting_pixels_post	POST /api/v1/retargeting/pixels	Create a retargeting pixel.

api_v1_retargeting_pixels_get

ApiV1RetargetingPixelsGet200Response api_v1_retargeting_pixels_get()

List the caller's retargeting pixels.

Every live list in one response — not paginated (total_rows is the count). Requires the tenant's retargeting module (modules.advertiser.retargetting); 403 when it is off.

Example

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

import goadserver
from goadserver.models.api_v1_retargeting_pixels_get200_response import ApiV1RetargetingPixelsGet200Response
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.RetargetingApi(api_client)

    try:
        # List the caller's retargeting pixels.
        api_response = api_instance.api_v1_retargeting_pixels_get()
        print("The response of RetargetingApi->api_v1_retargeting_pixels_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RetargetingApi->api_v1_retargeting_pixels_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ApiV1RetargetingPixelsGet200Response

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_retargeting_pixels_id_active_patch

ApiV1RetargetingPixelsIdActivePatch200Response api_v1_retargeting_pixels_id_active_patch(id, api_v1_campaigns_type_id_active_patch_request)

Activate or deactivate a retargeting pixel.

Example

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

import goadserver
from goadserver.models.api_v1_campaigns_type_id_active_patch_request import ApiV1CampaignsTypeIdActivePatchRequest
from goadserver.models.api_v1_retargeting_pixels_id_active_patch200_response import ApiV1RetargetingPixelsIdActivePatch200Response
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.RetargetingApi(api_client)
    id = 56 # int | 
    api_v1_campaigns_type_id_active_patch_request = goadserver.ApiV1CampaignsTypeIdActivePatchRequest() # ApiV1CampaignsTypeIdActivePatchRequest | 

    try:
        # Activate or deactivate a retargeting pixel.
        api_response = api_instance.api_v1_retargeting_pixels_id_active_patch(id, api_v1_campaigns_type_id_active_patch_request)
        print("The response of RetargetingApi->api_v1_retargeting_pixels_id_active_patch:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RetargetingApi->api_v1_retargeting_pixels_id_active_patch: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
api_v1_campaigns_type_id_active_patch_request	ApiV1CampaignsTypeIdActivePatchRequest

Return type

ApiV1RetargetingPixelsIdActivePatch200Response

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	New state	-

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

api_v1_retargeting_pixels_id_delete

ApiV1RetargetingPixelsIdDelete200Response api_v1_retargeting_pixels_id_delete(id)

Soft-delete a retargeting pixel and clear its captured visitors.

Sets isdeleted=1 in MySQL and asynchronously deletes the pixel's captured visitors (ClickHouse rt_pixels, the same cleanup the panel runs). Captured visitor IDs are gone — re-creating with the same name will start fresh. A campaign still pointing at the list (rt_id / rt_exclude_id) keeps the pointer.

Example

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

import goadserver
from goadserver.models.api_v1_retargeting_pixels_id_delete200_response import ApiV1RetargetingPixelsIdDelete200Response
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.RetargetingApi(api_client)
    id = 56 # int | 

    try:
        # Soft-delete a retargeting pixel and clear its captured visitors.
        api_response = api_instance.api_v1_retargeting_pixels_id_delete(id)
        print("The response of RetargetingApi->api_v1_retargeting_pixels_id_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RetargetingApi->api_v1_retargeting_pixels_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

ApiV1RetargetingPixelsIdDelete200Response

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Deleted	-
404	Not found (or already deleted)	-

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

api_v1_retargeting_pixels_id_get

RetargetingPixel api_v1_retargeting_pixels_id_get(id)

Get one retargeting pixel.

Example

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

import goadserver
from goadserver.models.retargeting_pixel import RetargetingPixel
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.RetargetingApi(api_client)
    id = 56 # int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

RetargetingPixel

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_retargeting_pixels_id_put

RetargetingPixel api_v1_retargeting_pixels_id_put(id, retargeting_pixel_write)

Update a retargeting pixel (name and visitor windows).

Partial update: fields not sent keep their stored value. At least one editable field is required (422 "Nothing to update." otherwise). Returns the updated record.

Example

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

import goadserver
from goadserver.models.retargeting_pixel import RetargetingPixel
from goadserver.models.retargeting_pixel_write import RetargetingPixelWrite
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.RetargetingApi(api_client)
    id = 56 # int | 
    retargeting_pixel_write = {"skipvisits":5} # RetargetingPixelWrite | 

    try:
        # Update a retargeting pixel (name and visitor windows).
        api_response = api_instance.api_v1_retargeting_pixels_id_put(id, retargeting_pixel_write)
        print("The response of RetargetingApi->api_v1_retargeting_pixels_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RetargetingApi->api_v1_retargeting_pixels_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
retargeting_pixel_write	RetargetingPixelWrite

Return type

RetargetingPixel

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Updated record	-
404	Not found	-
422	Validation error or nothing to update.	-

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

api_v1_retargeting_pixels_post

RetargetingPixel api_v1_retargeting_pixels_post(retargeting_pixel_write)

Create a retargeting pixel.

Same write path and validation as the panel. Windows not sent are 0 (off).

Example

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

import goadserver
from goadserver.models.retargeting_pixel import RetargetingPixel
from goadserver.models.retargeting_pixel_write import RetargetingPixelWrite
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.RetargetingApi(api_client)
    retargeting_pixel_write = {"name":"Cart abandoners","rmdays":30,"skiphours":1} # RetargetingPixelWrite | 

    try:
        # Create a retargeting pixel.
        api_response = api_instance.api_v1_retargeting_pixels_post(retargeting_pixel_write)
        print("The response of RetargetingApi->api_v1_retargeting_pixels_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RetargetingApi->api_v1_retargeting_pixels_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
retargeting_pixel_write	RetargetingPixelWrite

Return type

RetargetingPixel

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 — `errors` is keyed by the panel field names (`name`, `rmdays`, `skipdays`, `skiphours`, `skipvisits`), or an unknown key.	-

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

FilesExpand file tree

RetargetingApi.md

Latest commit

History

RetargetingApi.md

File metadata and controls

goadserver.RetargetingApi

api_v1_retargeting_pixels_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v1_retargeting_pixels_id_active_patch

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v1_retargeting_pixels_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v1_retargeting_pixels_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v1_retargeting_pixels_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v1_retargeting_pixels_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details