Skip to content

About

Official Go client for the GoAdserver REST API

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Go API client for goadserver

Official Go client for the REST API of GoAdserver, the hosted ad server. API documentation and how to create an API key: GoAdserver API docs.

Public REST API for advertisers and publishers on the GoAdServer platform.

Authentication. All endpoints (except /api/public/_*) require an API key passed as Authorization: Bearer gas_live_…. Create and manage keys in your account settings — each key has its own scopes, optional resource pinning, optional IP allowlist, and per-key rate limit.

Apps (OAuth 2.0). A tool other people connect uses an app token instead: authorization code + PKCE at /oauth/authorize, tokens from /api/public/oauth/token, passed as Authorization: Bearer oat_… on the same endpoints with the same scopes. See the Build an integration guide.

System rules apply over API rules. The public API never lets a key bypass restrictions the same user faces in the panel:

  • Source names (stats_source_names right). When the user lacks this right, advertiser stats responses return {id, name} with name equal to the id — no human label leaks through.
  • SubID encoding (modules.global.subid_encoding). When enabled for the system, the user only ever sees encoded SubIDs in the panel. The API mirrors this both ways: subid_excl/subid_incl filter endpoints accept the encoded form on write (decoded server-side before storage) and emit the encoded form on read. A plain SubID sent on write is stored as sent — a value is decoded only when it is a genuine encoded token.
  • Module gating. Endpoints whose module is disabled for the tenant don't appear in the spec or routes.txt at all.

Rate limits. Every response to an API key or app token carries the caller's budget for the current one-minute window:

Header Meaning
X-RateLimit-Limit Requests per minute for this key (its rate_limit_rpm, default 60; an app's per-installation limit for app tokens).
X-RateLimit-Remaining Calls left in the current window.
X-RateLimit-Reset Unix seconds at which the window resets.
Retry-After On 429 rate_limited only: seconds until a retry can succeed.

Windows are fixed and start with the first call, so Reset is exact. The MCP endpoint (POST /api/v1/mcp) is charged per tools/call against its own bucket (default 240/min), and its response headers report that bucket; an exhausted MCP bucket answers the tool call with an error result rather than an HTTP 429, and the HTTP response then carries Retry-After.

Idempotent writes. Send Idempotency-Key: <1–255 printable ASCII characters> (a UUID is ideal) on a POST or PATCH to make a retry safe. For 24 hours per key (per app installation for app tokens):

  • the first request runs and its response — status, body, Content-Type, Location, ETag — is stored;
  • the same key with the same method, path, query and body replays that response without running anything, adding Idempotent-Replayed: true;
  • the same key with a different request is 422 idempotency_key_reused;
  • the same key while the first request is still running is 409 idempotency_key_in_progress (with Retry-After: 1).

5xx results are not stored — the key is released and a retry runs again. Bodies over 32 MB cannot carry the header (413). An invalid key is 400 invalid_idempotency_key.

Concurrency control (ETag / If-Match). Every JSON GET response (up to 1 MB) carries a weak ETag, a hash of the body. Send it back:

  • If-None-Match: <etag> on a GET — 304 Not Modified when unchanged;
  • If-Match: <etag> on a PATCH, PUT or DELETE — the server reads the resource's current representation (the GET of the same path, or of the nearest parent path that has a GET: PATCH …/campaigns/ron/7/active is checked against GET …/campaigns/ron/7) and answers 412 precondition_failed when it no longer matches, with the current tag in ETag and current_etag. If-Match: * only requires the resource to exist. A resource with no readable representation is also 412.

The check is optimistic, not a lock: it closes the read-modify-write window two agents (or an agent and a person in the panel) would otherwise race in. Fields that change on their own (live spend counters) change the tag too — re-read and retry. A write response carries no new ETag; GET again.

Strict fields. Unknown body fields are a client error, not something to ignore: a request that sends a field the endpoint does not accept gets 422 unknown_fields naming it. This is the default for keys created from 2026-10-12 (the key's strict_fields setting, shown on the key screen); older keys keep ignoring unknown fields (except on the few endpoints that have always refused them — the budget and on/off toggles). Override per request with ?strict=1 (reject) or ?strict=0 (ignore, everywhere). App tokens default to ignoring unknown fields; ?strict=1 opts in.

Errors. Every non-2xx response has the same shape:

{ \"error\": \"validation_error\", \"message\": \"Name is required.\", \"errors\": { \"name\": [\"Name is required.\"] } }

error is a stable machine-readable code — branch on it, never on message. errors (field → messages) appears on field-level validation failures; some codes add their own members (scope, accepted_scopes, unknown_fields, current_etag). Codes:

Status Codes
400 bad_request, invalid_idempotency_key, invalid_body
401 unauthenticated, invalid_api_key, revoked_api_key, expired_api_key, invalid_token, revoked_token, expired_token, user_not_found, account_deleted, account_disabled, admin_key_on_user_api, user_key_on_admin_api
403 forbidden, missing_scope, forbidden_resource, ip_not_allowed, api_disabled, systemid_mismatch, endpoint_not_api_accessible, oauth_token_wrong_surface, mcp_not_enabled_for_app
404 not_found (also a disabled module or missing right — see ModuleDisabled)
405 method_not_allowed — the Allow header (and the message) lists the methods the path does accept
409 conflict, idempotency_key_in_progress, and resource-specific conflicts (e.g. email_exists)
412 precondition_failed
413 payload_too_large
422 validation_error, unknown_fields, idempotency_key_reused
429 rate_limited
5xx server_error, service_unavailable, bad_gateway, gateway_timeout

Endpoint-specific codes are listed on the endpoint. A response that would otherwise lack a code gets the generic one for its status from this table.

Client SDKs. Each SDK is generated from this spec and published as a public GitHub repository under the goadserver organization. The same tarball is also embedded in the API server and downloadable from /api/public/sdk/<lang>.tgz — useful when GitHub is unreachable.

Per-network host. The default https://up.go-adserver.com baked into the published SDKs is a reference host. Every white-label tenant runs on its own panel domain — override the host on first use (setHost() / Configuration.host / basePath etc.). Or, fetch the spec from your own tenant (/api/public/openapi.yaml returns it with your hostname as the default) and regenerate the SDK locally — the regenerated client has your URL baked in.

  • PHP — github.com/goadserver/goadserver-php (namespace GoAdServer\\Api, composer name goadserver/sdk).

    composer config repositories.goadserver vcs https://github.com/goadserver/goadserver-php
    composer require goadserver/sdk:dev-main
    $cfg = GoAdServer\\Api\\Configuration::getDefaultConfiguration()
            ->setHost('https://up.go-adserver.com')
            ->setAccessToken('gas_live_…');
    $api = new GoAdServer\\Api\\Api\\AccountAPIApi(null, $cfg);
    $me  = $api->apiV1AccountGet();
  • Go — github.com/goadserver/goadserver-go.

    go get github.com/goadserver/goadserver-go@latest
    import gas \"github.com/goadserver/goadserver-go\"
    
    cfg := gas.NewConfiguration()
    cfg.Servers = gas.ServerConfigurations{{URL: \"https://up.go-adserver.com\"}}
    cli := gas.NewAPIClient(cfg)
    ctx := context.WithValue(context.Background(),
        gas.ContextAccessToken, \"gas_live_…\")
    me, _, err := cli.AccountAPI.ApiV1AccountGet(ctx).Execute()
  • Python — github.com/goadserver/goadserver-python (package goadserver). Pulls pydantic + urllib3 automatically.

    pip install git+https://github.com/goadserver/goadserver-python.git
    from goadserver import ApiClient, Configuration
    from goadserver.api import AccountApi, CampaignsApi
    
    cfg = Configuration(host=\"https://up.go-adserver.com\")
    cfg.access_token = \"gas_live_…\"
    client = ApiClient(cfg)
    
    me = AccountApi(client).api_v1_account_get()
    camps = CampaignsApi(client).api_v1_campaigns_get(per_page=10)
  • JavaScript / TypeScript — github.com/goadserver/goadserver-js (npm name goadserver-sdk, generator typescript-fetch).

    npm install github:goadserver/goadserver-js
    import { Configuration, AccountApi, CampaignsApi }
      from \"goadserver-sdk\";
    
    const cfg = new Configuration({
      basePath: \"https://up.go-adserver.com\",
      accessToken: \"gas_live_…\",
    });
    
    const me   = await new AccountApi(cfg).apiV1AccountGet();
    const list = await new CampaignsApi(cfg).apiV1CampaignsGet({ perPage: 10 });

    The CJS build is broadly compatible (Node + bundlers); the ESM build is missing trailing .js extensions in its imports, a known typescript-fetch quirk — most consumers use CJS.

Offline / firewalled install. If the customer's network can't reach GitHub, every SDK's source is also served as a tarball from the API host:

curl -O https://up.go-adserver.com/api/public/sdk/python.tgz
tar xzf python.tgz && pip install ./python

Round-trip smoke tests for all four SDKs live at clients/_smoke/ in the platform repo.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.1.0
  • Generator version: 7.21.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Import the package in a go file in your project and run go mod tidy:

import goadserver "github.com/goadserver/goadserver-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value goadserver.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), goadserver.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value goadserver.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), goadserver.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using goadserver.ContextOperationServerIndices and goadserver.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), goadserver.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), goadserver.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

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

Class Method HTTP request Description
AIAssistantAPI ApiV1McpPost Post /api/v1/mcp MCP endpoint — connect an AI assistant to this account.
AccountAPI ApiV1AccountFeaturesGet Get /api/v1/account/features Self-service features and their state.
AccountAPI ApiV1AccountGet Get /api/v1/account Identity check — returns the authenticated user + scopes of the calling key.
AccountAPI ApiV1AccountMembershipsGet Get /api/v1/account/memberships Accounts this login can act on.
AccountAPI ApiV1AccountNoticesGet Get /api/v1/account/notices Account notices.
AccountAPI ApiV1AccountPendingChangesGet Get /api/v1/account/pending-changes Profile changes awaiting verification.
AccountAPI ApiV1AccountPreferencesGet Get /api/v1/account/preferences Per-member preferences.
AccountAPI ApiV1AccountPreferencesKeyPut Put /api/v1/account/preferences/{key} Set one preference.
AccountAPI ApiV1AccountProfileGet Get /api/v1/account/profile The account's contact and company details.
AccountAPI ApiV1AccountSalesReferralsGet Get /api/v1/account/sales-referrals Your sales referrals — clients assigned to you, their deposits and your commission.
AccountAPI ApiV1AccountSettingsGet Get /api/v1/account/settings Account settings.
AccountAPI ApiV1AccountUiLayoutsGet Get /api/v1/account/ui-layouts Saved menu layouts.
AccountAPI ApiV1AccountUiLayoutsScopeDelete Delete /api/v1/account/ui-layouts/{scope} Reset a menu layout.
AccountAPI ApiV1AccountUiLayoutsScopePut Put /api/v1/account/ui-layouts/{scope} Save a menu layout.
AccountAPI ApiV1AccountUsageGet Get /api/v1/account/usage Metered usage for a period.
AccountAPI ApiV1AccountUsageSummaryGet Get /api/v1/account/usage-summary Inventory counts at a glance.
AccountBillingAPI ApiV1AccountBillingAffiliatedPaymentsGet Get /api/v1/account/billing/affiliated-payments Payments made to affiliated accounts.
AccountBillingAPI ApiV1AccountBillingAveragesGet Get /api/v1/account/billing/averages Average costs and overcharges.
AccountBillingAPI ApiV1AccountBillingInvoicesGet Get /api/v1/account/billing/invoices List invoices.
AccountBillingAPI ApiV1AccountBillingInvoicesIdPdfGet Get /api/v1/account/billing/invoices/{id}/pdf Download an invoice PDF.
AccountBillingAPI ApiV1AccountBillingSettingsGet Get /api/v1/account/billing/settings The account's billing plan.
AccountNotificationsAPI ApiV1AccountNotificationDestinationsGet Get /api/v1/account/notification-destinations The account's notification destinations.
AccountNotificationsAPI ApiV1AccountNotificationDestinationsIdDelete Delete /api/v1/account/notification-destinations/{id} Delete a notification destination.
AccountNotificationsAPI ApiV1AccountNotificationDestinationsIdStatusGet Get /api/v1/account/notification-destinations/{id}/status Whether a destination is linked.
AccountNotificationsAPI ApiV1AccountNotificationDestinationsIdTestPost Post /api/v1/account/notification-destinations/{id}/test Send a test message to a destination.
AccountNotificationsAPI ApiV1AccountNotificationDestinationsPost Post /api/v1/account/notification-destinations Add a notification destination.
AccountNotificationsAPI ApiV1AccountNotificationPreferencesGet Get /api/v1/account/notification-preferences Per-event channel preferences.
AccountNotificationsAPI ApiV1AccountNotificationPreferencesPut Put /api/v1/account/notification-preferences Save channel preferences.
AccountNotificationsAPI ApiV1AccountNotificationsGet Get /api/v1/account/notifications The in-app notification feed.
AccountNotificationsAPI ApiV1AccountNotificationsReadPost Post /api/v1/account/notifications/read Mark notifications read.
AccountNotificationsAPI ApiV1AccountNotificationsUnreadCountGet Get /api/v1/account/notifications/unread-count Unread notification count.
AdScannerAPI ApiV1AdScannerGet Get /api/v1/ad-scanner List scan tasks.
AdScannerAPI ApiV1AdScannerIdDelete Delete /api/v1/ad-scanner/{id} Delete a scan task.
AdScannerAPI ApiV1AdScannerIdIgnoreDomainPut Put /api/v1/ad-scanner/{id}/ignore-domain Ignore (or un-ignore) a flagged domain on a task.
AdScannerAPI ApiV1AdScannerIdManualItemsGet Get /api/v1/ad-scanner/{id}/manual-items List a manual task's items.
AdScannerAPI ApiV1AdScannerIdManualItemsItemIdStatePut Put /api/v1/ad-scanner/{id}/manual-items/{itemId}/state Pause, resume or delete a manual item.
AdScannerAPI ApiV1AdScannerIdManualItemsPost Post /api/v1/ad-scanner/{id}/manual-items Add or edit a manual item.
AdScannerAPI ApiV1AdScannerIdPut Put /api/v1/ad-scanner/{id} Replace a task's name, tags and config.
AdScannerAPI ApiV1AdScannerIdToggleActivePut Put /api/v1/ad-scanner/{id}/toggle-active Start or stop a scan task.
AdScannerAPI ApiV1AdScannerPost Post /api/v1/ad-scanner Create a scan task.
AdScannerAPI ApiV1AdScannerReportHashGet Get /api/v1/ad-scanner/report/{hash} One scan's full report.
AdScannerAPI ApiV1AdScannerReportsGet Get /api/v1/ad-scanner/reports List scan results.
AdScannerAPI ApiV1AdScannerStatsGet Get /api/v1/ad-scanner/stats Scan volume and proxy bandwidth.
AdScannerAPI ApiV1AdScannerTagsGet Get /api/v1/ad-scanner/tags Tags used on the account's scan tasks.
AdShopAPI ApiV1AdShopCartGet Get /api/v1/ad-shop/cart Read the draft cart.
AdShopAPI ApiV1AdShopCartPost Post /api/v1/ad-shop/cart Replace the draft cart.
AdShopAPI ApiV1AdShopConfirmPost Post /api/v1/ad-shop/confirm Check out the cart — creates the campaigns.
AdShopAPI ApiV1AdShopFilterOptionsGet Get /api/v1/ad-shop/filter-options Filter values present in the current snapshot.
AdShopAPI ApiV1AdShopGroupSummaryPost Post /api/v1/ad-shop/group-summary Group the catalog by targeting dimensions.
AdShopAPI ApiV1AdShopOpportunitiesGet Get /api/v1/ad-shop/opportunities Browse Ad Shop opportunities.
AdShopAPI ApiV1AdShopPlanGet Get /api/v1/ad-shop/plan Preview how the cart becomes campaigns.
AdsAPI ApiV1CampaignsTypeCampaignIdAdsMassUndeletePost Post /api/v1/campaigns/{type}/{campaignId}/ads/mass-undelete Restore archived ads of a campaign.
AdspacesAPI ApiV1AdspacesAddMultiplePost Post /api/v1/adspaces/add-multiple Create several ad zones of one type on one site.
AdspacesAPI ApiV1AdspacesExportCodesGet Get /api/v1/adspaces/export-codes Embed codes for many ad zones at once, grouped by site.
AdspacesAPI ApiV1AdspacesGet Get /api/v1/adspaces List ad zones owned by the caller.
AdspacesAPI ApiV1AdspacesIdBlockedAdvertisersGet Get /api/v1/adspaces/{id}/blocked-advertisers Advertiser block filters that exclude this ad zone.
AdspacesAPI ApiV1AdspacesIdChildrenGet Get /api/v1/adspaces/{id}/children List an ad zone's child zones.
AdspacesAPI ApiV1AdspacesIdClonePost Post /api/v1/adspaces/{id}/clone Duplicate an ad zone.
AdspacesAPI ApiV1AdspacesIdCodeGet Get /api/v1/adspaces/{id}/code Embed-code snippets for an adspace.
AdspacesAPI ApiV1AdspacesIdDelete Delete /api/v1/adspaces/{id} Soft-delete an adspace.
AdspacesAPI ApiV1AdspacesIdGet Get /api/v1/adspaces/{id} Get a single adspace.
AdspacesAPI ApiV1AdspacesIdNetworkBindingDelete Delete /api/v1/adspaces/{id}/network-binding Remove the zone's network binding.
AdspacesAPI ApiV1AdspacesIdNetworkBindingPut Put /api/v1/adspaces/{id}/network-binding Bind the zone to a campaign on an external ad network (the Source tab).
AdspacesAPI ApiV1AdspacesIdOwnAdsAdIdDelete Delete /api/v1/adspaces/{id}/own-ads/{adId} Delete an own ad.
AdspacesAPI ApiV1AdspacesIdOwnAdsAdIdGet Get /api/v1/adspaces/{id}/own-ads/{adId} Get one own ad.
AdspacesAPI ApiV1AdspacesIdOwnAdsAdIdPut Put /api/v1/adspaces/{id}/own-ads/{adId} Update an own ad.
AdspacesAPI ApiV1AdspacesIdOwnAdsAdIdTogglePut Put /api/v1/adspaces/{id}/own-ads/{adId}/toggle Switch an own ad on/off.
AdspacesAPI ApiV1AdspacesIdOwnAdsGet Get /api/v1/adspaces/{id}/own-ads List the zone's own (house / fallback) ads.
AdspacesAPI ApiV1AdspacesIdOwnAdsMassActionPost Post /api/v1/adspaces/{id}/own-ads/mass-action Activate, deactivate or delete several own ads.
AdspacesAPI ApiV1AdspacesIdOwnAdsPost Post /api/v1/adspaces/{id}/own-ads Add an own ad.
AdspacesAPI ApiV1AdspacesIdPatch Patch /api/v1/adspaces/{id} Update an existing adspace.
AdspacesAPI ApiV1AdspacesIdPricesTypeGet Get /api/v1/adspaces/{id}/prices/{type} Minimum (floor) prices per country for one device type.
AdspacesAPI ApiV1AdspacesIdPricesTypePost Post /api/v1/adspaces/{id}/prices/{type} Replace the floor prices for one device type.
AdspacesAPI ApiV1AdspacesIdRecoverPost Post /api/v1/adspaces/{id}/recover Reverse a soft-delete on an adspace.
AdspacesAPI ApiV1AdspacesIdWlCampaignsGet Get /api/v1/adspaces/{id}/wl-campaigns Campaigns that can be whitelisted on this zone, and the current whitelist.
AdspacesAPI ApiV1AdspacesIdWlCampaignsPut Put /api/v1/adspaces/{id}/wl-campaigns Replace the zone's whitelisted campaigns.
AdspacesAPI ApiV1AdspacesMassDeletePost Post /api/v1/adspaces/mass-delete Soft-delete several ad zones.
AdspacesAPI ApiV1AdspacesMassRecoverPost Post /api/v1/adspaces/mass-recover Recover several soft-deleted ad zones.
AdspacesAPI ApiV1AdspacesTemplatesGet Get /api/v1/adspaces/templates List your saved ad zone templates.
AdspacesAPI ApiV1AdspacesTemplatesIdDelete Delete /api/v1/adspaces/templates/{id} Delete a template.
AdspacesAPI ApiV1AdspacesTemplatesIdPut Put /api/v1/adspaces/templates/{id} Replace a template's data.
AdspacesAPI ApiV1AdspacesTemplatesPost Post /api/v1/adspaces/templates Save an ad zone template.
AdspacesAPI ApiV1AdspacesTypePost Post /api/v1/adspaces/{type} Create a new adspace.
AdspacesAPI ApiV1AdspacesTypeSchemaGet Get /api/v1/adspaces/{type}/_schema Field metadata for create/update of one adspace type.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingActionsActionIdDecidePost Post /api/v1/adspaces/{id}/media-buying/actions/{actionId}/decide Approve or reject a proposal.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingActionsGet Get /api/v1/adspaces/{id}/media-buying/actions Activity log: every block, bid, budget and other change, and open proposals.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingAgentRunPost Post /api/v1/adspaces/{id}/media-buying/agent/run Run the buying agent now.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingAgentRunsGet Get /api/v1/adspaces/{id}/media-buying/agent/runs The buying agent's recent runs with their summaries and proposals.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingBlockPost Post /api/v1/adspaces/{id}/media-buying/block Block or unblock one source zone at the network.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingCompareGet Get /api/v1/adspaces/{id}/media-buying/compare Compare with another buy (A/B, e.g. against a control left to the network's own optimiser).
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingGet Get /api/v1/adspaces/{id}/media-buying Overview: the connected network, what it supports, the policy and open proposals.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingIpsGet Get /api/v1/adspaces/{id}/media-buying/ips The IP preblock list: ranges on the network's exclusion list and proposals.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingIpsPost Post /api/v1/adspaces/{id}/media-buying/ips Change the IP preblock list.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingLaunchGet Get /api/v1/adspaces/{id}/media-buying/launch What a new campaign can be launched with (unconnected ad zones).
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingLaunchPost Post /api/v1/adspaces/{id}/media-buying/launch Launch a new campaign at the network for this ad zone.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingLaunchTemplatesGet Get /api/v1/adspaces/{id}/media-buying/launch/templates Existing campaigns that can be cloned for a launch.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingNetworkBudgetGet Get /api/v1/adspaces/{id}/media-buying/network-budget The campaign's daily budget at the network.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingPolicyPut Put /api/v1/adspaces/{id}/media-buying/policy Save the buying policy (any subset of its fields).
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingPolicySuggestGet Get /api/v1/adspaces/{id}/media-buying/policy/suggest Suggested policy from the zone's own traffic, with a reason per field.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingReportPost Post /api/v1/adspaces/{id}/media-buying/report Send the media buying report now.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingSegmentsGet Get /api/v1/adspaces/{id}/media-buying/segments Cost and revenue per segment: country, OS, hour, day of week, browser, region, carrier, language.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingSourceBidGet Get /api/v1/adspaces/{id}/media-buying/source/bid The campaign's current bid at the network.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingSourceBidPut Put /api/v1/adspaces/{id}/media-buying/source/bid Set the campaign's bid at the network.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingSourceRetryPost Post /api/v1/adspaces/{id}/media-buying/source/retry Retry the connection to the source campaign.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingTargetingGet Get /api/v1/adspaces/{id}/media-buying/targeting The campaign's placement targeting (all, or an allow-list).
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingTargetingPut Put /api/v1/adspaces/{id}/media-buying/targeting Switch to / edit the allow-list, or back to all placements.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingTargetingSuggestGet Get /api/v1/adspaces/{id}/media-buying/targeting/suggest Suggested allow-list: the profitable placements of the policy window.
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingTrackRecordGet Get /api/v1/adspaces/{id}/media-buying/track-record Track record: did each change do what it was meant to?
AgenticMediaBuyingAPI ApiV1AdspacesIdMediaBuyingZonesGet Get /api/v1/adspaces/{id}/media-buying/zones Source-zone report: revenue against cost per placement.
AgenticMediaBuyingAPI ApiV1MediaBuyingPortfolioGet Get /api/v1/media-buying/portfolio Every buy side by side: margin against target, spend, proposals, the agent's latest summary.
AgenticMediaBuyingAPI ApiV1TrackerMediaBuyingPortfolioGet Get /api/v1/tracker/media-buying/portfolio Every buy side by side (tracker accounts — the same overview): margin against target, spend, proposals, the agent's latest summary.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingActionsActionIdDecidePost Post /api/v1/tracker/tracking-links/{id}/media-buying/actions/{actionId}/decide Approve or reject a proposal.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingActionsGet Get /api/v1/tracker/tracking-links/{id}/media-buying/actions Activity log: every block, bid, budget and other change, and open proposals.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingAgentRunPost Post /api/v1/tracker/tracking-links/{id}/media-buying/agent/run Run the buying agent now.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingAgentRunsGet Get /api/v1/tracker/tracking-links/{id}/media-buying/agent/runs The buying agent's recent runs with their summaries and proposals.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingBlockPost Post /api/v1/tracker/tracking-links/{id}/media-buying/block Block or unblock one source zone at the network.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingCompareGet Get /api/v1/tracker/tracking-links/{id}/media-buying/compare Compare with another buy (A/B, e.g. against a control left to the network's own optimiser).
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingGet Get /api/v1/tracker/tracking-links/{id}/media-buying Overview: the connected network, what it supports, the policy and open proposals.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingIpsGet Get /api/v1/tracker/tracking-links/{id}/media-buying/ips The IP preblock list: ranges on the network's exclusion list and proposals.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingIpsPost Post /api/v1/tracker/tracking-links/{id}/media-buying/ips Change the IP preblock list.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingNetworkBudgetGet Get /api/v1/tracker/tracking-links/{id}/media-buying/network-budget The campaign's daily budget at the network.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingPolicyPut Put /api/v1/tracker/tracking-links/{id}/media-buying/policy Save the buying policy (any subset of its fields).
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingPolicySuggestGet Get /api/v1/tracker/tracking-links/{id}/media-buying/policy/suggest Suggested policy from the zone's own traffic, with a reason per field.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingReportPost Post /api/v1/tracker/tracking-links/{id}/media-buying/report Send the media buying report now.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingSegmentsGet Get /api/v1/tracker/tracking-links/{id}/media-buying/segments Cost and revenue per segment: country, OS, hour, day of week, browser, region, carrier, language.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingSourceBidGet Get /api/v1/tracker/tracking-links/{id}/media-buying/source/bid The campaign's current bid at the network.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingSourceBidPut Put /api/v1/tracker/tracking-links/{id}/media-buying/source/bid Set the campaign's bid at the network.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingSourceRetryPost Post /api/v1/tracker/tracking-links/{id}/media-buying/source/retry Retry the connection to the source campaign.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingTargetingGet Get /api/v1/tracker/tracking-links/{id}/media-buying/targeting The campaign's placement targeting (all, or an allow-list).
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingTargetingPut Put /api/v1/tracker/tracking-links/{id}/media-buying/targeting Switch to / edit the allow-list, or back to all placements.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingTargetingSuggestGet Get /api/v1/tracker/tracking-links/{id}/media-buying/targeting/suggest Suggested allow-list: the profitable placements of the policy window.
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingTrackRecordGet Get /api/v1/tracker/tracking-links/{id}/media-buying/track-record Track record: did each change do what it was meant to?
AgenticMediaBuyingAPI ApiV1TrackerTrackingLinksIdMediaBuyingZonesGet Get /api/v1/tracker/tracking-links/{id}/media-buying/zones Source-zone report: revenue against cost per placement.
BidRulesetsAPI ApiV1BidRulesetsGet Get /api/v1/bid-rulesets List the caller's bid rulesets (lightweight rows).
BidRulesetsAPI ApiV1BidRulesetsIdClonePost Post /api/v1/bid-rulesets/{id}/clone Clone a ruleset with all its rules.
BidRulesetsAPI ApiV1BidRulesetsIdDelete Delete /api/v1/bid-rulesets/{id} Soft-delete a ruleset.
BidRulesetsAPI ApiV1BidRulesetsIdGet Get /api/v1/bid-rulesets/{id} Show one ruleset, including all rules.
BidRulesetsAPI ApiV1BidRulesetsIdPatch Patch /api/v1/bid-rulesets/{id} Update a ruleset's metadata and/or replace its rules.
BidRulesetsAPI ApiV1BidRulesetsPost Post /api/v1/bid-rulesets Create a new bid ruleset (with rules in one shot).
CampaignsAPI ApiV1CampaignsCpmCampaignIdSpotsSpaceIdDelete Delete /api/v1/campaigns/cpm/{campaignId}/spots/{spaceId} Remove an ad zone from a CPM campaign.
CampaignsAPI ApiV1CampaignsCpmCampaignIdSpotsSpaceIdPost Post /api/v1/campaigns/cpm/{campaignId}/spots/{spaceId} Add an ad zone to a CPM campaign (or re-price it).
CampaignsAPI ApiV1CampaignsCpmCampaignIdSpotsSpaceIdPut Put /api/v1/campaigns/cpm/{campaignId}/spots/{spaceId} Switch a CPM campaign's zone spot on or off.
CampaignsAPI ApiV1CampaignsCpmCampaignIdSpotsSpaceIdTypePut Put /api/v1/campaigns/cpm/{campaignId}/spots/{spaceId}/{type} Set a CPM zone spot's bid or state.
CampaignsAPI ApiV1CampaignsGet Get /api/v1/campaigns List the caller's campaigns across all types (or one type).
CampaignsAPI ApiV1CampaignsMassDeletePost Post /api/v1/campaigns/mass-delete Soft-delete many campaigns.
CampaignsAPI ApiV1CampaignsMassTogglePut Put /api/v1/campaigns/mass-toggle Pause or resume many campaigns at once.
CampaignsAPI ApiV1CampaignsMassUndeletePost Post /api/v1/campaigns/mass-undelete Restore soft-deleted campaigns.
CampaignsAPI ApiV1CampaignsPurgePost Post /api/v1/campaigns/purge Permanently delete soft-deleted campaigns and their ads.
CampaignsAPI ApiV1CampaignsRonCampaignIdAdsAdIdZoneBidsGet Get /api/v1/campaigns/ron/{campaignId}/ads/{adId}/zone-bids List per-zone bid overrides for a RON ad.
CampaignsAPI ApiV1CampaignsRonCampaignIdAdsAdIdZoneBidsPut Put /api/v1/campaigns/ron/{campaignId}/ads/{adId}/zone-bids Replace the per-zone bid overrides on a RON ad.
CampaignsAPI ApiV1CampaignsRonCampaignIdAdsAdIdZoneBidsZoneIdDelete Delete /api/v1/campaigns/ron/{campaignId}/ads/{adId}/zone-bids/{zoneId} Clear a single per-zone bid override.
CampaignsAPI ApiV1CampaignsRonCampaignIdAdsAdIdZoneBidsZonesOnlyPut Put /api/v1/campaigns/ron/{campaignId}/ads/{adId}/zone-bids/zones-only Switch &quot;only these zones&quot; mode for a RON ad's per-zone bids.
CampaignsAPI ApiV1CampaignsRonIdSiteListGet Get /api/v1/campaigns/ron/{id}/site-list The Premium-sites box of a RON campaign.
CampaignsAPI ApiV1CampaignsRonIdSiteListSiteIdPut Put /api/v1/campaigns/ron/{id}/site-list/{siteId} Set one site of the Premium-sites box active or blocked.
CampaignsAPI ApiV1CampaignsRonIdZonesGet Get /api/v1/campaigns/ron/{id}/zones List the zones a RON campaign is linked to.
CampaignsAPI ApiV1CampaignsRtbIdTestRtbGet Get /api/v1/campaigns/rtb/{id}/test-rtb Context for testing an RTB campaign's endpoint.
CampaignsAPI ApiV1CampaignsRtbIdTestRtbPost Post /api/v1/campaigns/rtb/{id}/test-rtb Fire a test bid request at an RTB campaign's endpoint.
CampaignsAPI ApiV1CampaignsSaveCategoriesPut Put /api/v1/campaigns/save-categories Assign categories to many campaigns.
CampaignsAPI ApiV1CampaignsSaveTagsPut Put /api/v1/campaigns/save-tags Assign tags (campaign groups) to many campaigns.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsAdIdActivePatch Patch /api/v1/campaigns/{type}/{campaignId}/ads/{adId}/active Pause or unpause a single ad.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsAdIdBidPatch Patch /api/v1/campaigns/{type}/{campaignId}/ads/{adId}/bid Set a single ad's bid.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsAdIdBidsPerGeoPut Put /api/v1/campaigns/{type}/{campaignId}/ads/{adId}/bids-per-geo Set per-country bids for a RON ad.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsAdIdClonePost Post /api/v1/campaigns/{type}/{campaignId}/ads/{adId}/clone Clone a single ad within a campaign.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsAdIdCountriesPut Put /api/v1/campaigns/{type}/{campaignId}/ads/{adId}/countries Set per-ad country targeting for a RON ad.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsAdIdDelete Delete /api/v1/campaigns/{type}/{campaignId}/ads/{adId} Soft-delete an ad.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsAdIdGet Get /api/v1/campaigns/{type}/{campaignId}/ads/{adId} Show one ad.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsAdIdOverlayStatsGet Get /api/v1/campaigns/{type}/{campaignId}/ads/{adId}/overlay-stats Shoppable video — shown and clicks per overlay.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsAdIdPut Put /api/v1/campaigns/{type}/{campaignId}/ads/{adId} Update an ad.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsAdIdRestorePut Put /api/v1/campaigns/{type}/{campaignId}/ads/{adId}/restore Restore a deleted RON ad.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsCopyTargetsGet Get /api/v1/campaigns/{type}/{campaignId}/ads/copy-targets Campaigns this campaign's ads can be copied into.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsCsvImportPost Post /api/v1/campaigns/{type}/{campaignId}/ads/csv-import Import native ads from a CSV — one ad per row, or one ad per group.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsFromPoolPost Post /api/v1/campaigns/{type}/{campaignId}/ads/from-pool Create ads from a creative pool.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsGet Get /api/v1/campaigns/{type}/{campaignId}/ads List ads on a campaign.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsMassClonePost Post /api/v1/campaigns/{type}/{campaignId}/ads/mass-clone Copy many ads of a campaign.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsMassDeletePost Post /api/v1/campaigns/{type}/{campaignId}/ads/mass-delete Soft-delete many ads of a campaign.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsMassTogglePut Put /api/v1/campaigns/{type}/{campaignId}/ads/mass-toggle Activate or pause many ads of a campaign at once.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsMultiUploadPost Post /api/v1/campaigns/{type}/{campaignId}/ads/multi-upload Bulk-upload ads — one ad per creative file.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsPost Post /api/v1/campaigns/{type}/{campaignId}/ads Create an ad on a campaign (smart-default).
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsUpdatePoolPut Put /api/v1/campaigns/{type}/{campaignId}/ads/update-pool Point many ads at a different creative pool.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsUpdateUrlPoolPut Put /api/v1/campaigns/{type}/{campaignId}/ads/update-url-pool Point many ads at a URL pool, or detach it.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsUpdateUrlPut Put /api/v1/campaigns/{type}/{campaignId}/ads/update-url Rewrite the destination URL of many ads at once.
CampaignsAPI ApiV1CampaignsTypeCampaignIdAdsUpdateWeightPut Put /api/v1/campaigns/{type}/{campaignId}/ads/update-weight Set the rotation weight of one or more RON ads.
CampaignsAPI ApiV1CampaignsTypeCampaignIdSchemaAdsGet Get /api/v1/campaigns/{type}/{campaignId}/_schema/ads Field metadata for ad creation, scoped to a campaign.
CampaignsAPI ApiV1CampaignsTypeIdActivePatch Patch /api/v1/campaigns/{type}/{id}/active Pause or unpause a campaign.
CampaignsAPI ApiV1CampaignsTypeIdAvailableZonesGet Get /api/v1/campaigns/{type}/{id}/available-zones List your ad zones that can be attached to a campaign.
CampaignsAPI ApiV1CampaignsTypeIdBidsPatch Patch /api/v1/campaigns/{type}/{id}/bids Mass update bids on every ad in a campaign.
CampaignsAPI ApiV1CampaignsTypeIdBudgetPatch Patch /api/v1/campaigns/{type}/{id}/budget Update a campaign's total and/or daily budget.
CampaignsAPI ApiV1CampaignsTypeIdClonePost Post /api/v1/campaigns/{type}/{id}/clone Clone a campaign — everything, or the parts you pick.
CampaignsAPI ApiV1CampaignsTypeIdDelete Delete /api/v1/campaigns/{type}/{id} Soft-delete a campaign.
CampaignsAPI ApiV1CampaignsTypeIdFiltersFilterTypeFilterIdDelete Delete /api/v1/campaigns/{type}/{id}/filters/{filter_type}/{filter_id} Detach a filter from this campaign.
CampaignsAPI ApiV1CampaignsTypeIdFiltersGet Get /api/v1/campaigns/{type}/{id}/filters List filters attached to this campaign.
CampaignsAPI ApiV1CampaignsTypeIdFiltersPost Post /api/v1/campaigns/{type}/{id}/filters Attach a filter to this campaign.
CampaignsAPI ApiV1CampaignsTypeIdGet Get /api/v1/campaigns/{type}/{id} Get a single campaign.
CampaignsAPI ApiV1CampaignsTypeIdMinBidGet Get /api/v1/campaigns/{type}/{id}/min-bid Get the campaign's minimum acceptable CPC bid.
CampaignsAPI ApiV1CampaignsTypeIdPatch Patch /api/v1/campaigns/{type}/{id} Partially update a campaign.
CampaignsAPI ApiV1CampaignsTypeIdResetMaxBudgetPut Put /api/v1/campaigns/{type}/{id}/reset-max-budget Reset a campaign's lifetime-budget spend.
CampaignsAPI ApiV1CampaignsTypeIdSitesGet Get /api/v1/campaigns/{type}/{id}/sites Your sites that have zones attachable to a campaign.
CampaignsAPI ApiV1CampaignsTypeIdWhitelistZonesGet Get /api/v1/campaigns/{type}/{id}/whitelist-zones List the ad zones attached to a campaign.
CampaignsAPI ApiV1CampaignsTypeIdZonesPost Post /api/v1/campaigns/{type}/{id}/zones Attach ad zones to a campaign.
CampaignsAPI ApiV1CampaignsTypeIdZonesZoneIdDelete Delete /api/v1/campaigns/{type}/{id}/zones/{zoneId} Detach an ad zone from a campaign.
CampaignsAPI ApiV1CampaignsTypeIdZonesZoneIdWeightPut Put /api/v1/campaigns/{type}/{id}/zones/{zoneId}/weight Set an attached zone's weight for this campaign.
CampaignsAPI ApiV1CampaignsTypePost Post /api/v1/campaigns/{type} Create a new campaign (smart-default).
CampaignsAPI ApiV1CampaignsTypeSchemaAdsGet Get /api/v1/campaigns/{type}/_schema/ads Field metadata for ad creation.
CampaignsAPI ApiV1CampaignsTypeSchemaGet Get /api/v1/campaigns/{type}/_schema Field metadata for create/update.
CampaignsAPI ApiV1RtbTestRtbContextGet Get /api/v1/rtb/test-rtb/context Context for testing an endpoint before the campaign exists.
CampaignsAPI ApiV1RtbTestRtbPost Post /api/v1/rtb/test-rtb Fire a test bid request at any endpoint URL.
CampaignsAPI ApiV1ToolsReplaceDomainPut Put /api/v1/tools/replace-domain Replace the landing domain across your RON ads.
CleanupAPI ApiV1CleanupAdvertiserArchivedGet Get /api/v1/cleanup/advertiser/archived Archived advertiser items that can be purged.
CleanupAPI ApiV1CleanupAdvertiserExportGet Get /api/v1/cleanup/advertiser/export Download the advertiser cleanup candidates.
CleanupAPI ApiV1CleanupAdvertiserGet Get /api/v1/cleanup/advertiser List advertiser items that no longer serve.
CleanupAPI ApiV1CleanupAdvertiserLinkedGet Get /api/v1/cleanup/advertiser/linked What still uses advertiser cleanup rows.
CleanupAPI ApiV1CleanupAdvertiserPurgePost Post /api/v1/cleanup/advertiser/purge Purge archived advertiser items for good.
CleanupAPI ApiV1CleanupAdvertiserRunsGet Get /api/v1/cleanup/advertiser/runs Recent advertiser cleanup runs.
CleanupAPI ApiV1CleanupAdvertiserRunsIdGet Get /api/v1/cleanup/advertiser/runs/{id} One advertiser cleanup run with its items.
CleanupAPI ApiV1CleanupAdvertiserRunsIdUndonePost Post /api/v1/cleanup/advertiser/runs/{id}/undone Mark a advertiser cleanup run as undone.
CleanupAPI ApiV1CleanupAdvertiserRunsPost Post /api/v1/cleanup/advertiser/runs Record a advertiser cleanup run.
CleanupAPI ApiV1CleanupAdvertiserSummaryGet Get /api/v1/cleanup/advertiser/summary Count the advertiser cleanup candidates per kind.
CleanupAPI ApiV1CleanupPublisherArchivedGet Get /api/v1/cleanup/publisher/archived Archived publisher items that can be purged.
CleanupAPI ApiV1CleanupPublisherExportGet Get /api/v1/cleanup/publisher/export Download the publisher cleanup candidates.
CleanupAPI ApiV1CleanupPublisherGet Get /api/v1/cleanup/publisher List publisher items that no longer serve.
CleanupAPI ApiV1CleanupPublisherLinkedGet Get /api/v1/cleanup/publisher/linked What still uses publisher cleanup rows.
CleanupAPI ApiV1CleanupPublisherPurgePost Post /api/v1/cleanup/publisher/purge Purge archived publisher items for good.
CleanupAPI ApiV1CleanupPublisherRunsGet Get /api/v1/cleanup/publisher/runs Recent publisher cleanup runs.
CleanupAPI ApiV1CleanupPublisherRunsIdGet Get /api/v1/cleanup/publisher/runs/{id} One publisher cleanup run with its items.
CleanupAPI ApiV1CleanupPublisherRunsIdUndonePost Post /api/v1/cleanup/publisher/runs/{id}/undone Mark a publisher cleanup run as undone.
CleanupAPI ApiV1CleanupPublisherRunsPost Post /api/v1/cleanup/publisher/runs Record a publisher cleanup run.
CleanupAPI ApiV1CleanupPublisherSummaryGet Get /api/v1/cleanup/publisher/summary Count the publisher cleanup candidates per kind.
CouponsAPI ApiV1CouponsSetsGet Get /api/v1/coupons/sets List coupon sets.
CouponsAPI ApiV1CouponsSetsIdDelete Delete /api/v1/coupons/sets/{id} Delete a set and all its codes.
CouponsAPI ApiV1CouponsSetsIdExportGet Get /api/v1/coupons/sets/{id}/export Export a set's codes as CSV.
CouponsAPI ApiV1CouponsSetsIdGeneratePost Post /api/v1/coupons/sets/{id}/generate Generate codes in a set.
CouponsAPI ApiV1CouponsSetsIdPut Put /api/v1/coupons/sets/{id} Rename a set or move its end date.
CouponsAPI ApiV1CouponsSetsPost Post /api/v1/coupons/sets Create a coupon set.
CouponsAPI ApiV1CouponsSetsSetIdCouponsGet Get /api/v1/coupons/sets/{setId}/coupons List the codes in a set.
CreativePoolsAPI ApiV1CreativePoolsGet Get /api/v1/creative-pools List creative pools.
CreativePoolsAPI ApiV1CreativePoolsIdAddCreativesPost Post /api/v1/creative-pools/{id}/add-creatives Add media-bank creatives to a pool.
CreativePoolsAPI ApiV1CreativePoolsIdAddUrlsPost Post /api/v1/creative-pools/{id}/add-urls Add hotlinked image / video / HTML URLs to a pool.
CreativePoolsAPI ApiV1CreativePoolsIdClonePost Post /api/v1/creative-pools/{id}/clone Clone a creative pool with all its items.
CreativePoolsAPI ApiV1CreativePoolsIdDelete Delete /api/v1/creative-pools/{id} Soft-delete a creative pool.
CreativePoolsAPI ApiV1CreativePoolsIdGet Get /api/v1/creative-pools/{id} Show a single creative pool.
CreativePoolsAPI ApiV1CreativePoolsIdItemsExportGet Get /api/v1/creative-pools/{id}/items/export Download pool items' creative files as a ZIP.
CreativePoolsAPI ApiV1CreativePoolsIdItemsGet Get /api/v1/creative-pools/{id}/items List items in a creative pool.
CreativePoolsAPI ApiV1CreativePoolsIdItemsItemIdDelete Delete /api/v1/creative-pools/{id}/items/{itemId} Soft-delete a single pool item.
CreativePoolsAPI ApiV1CreativePoolsIdItemsItemIdPut Put /api/v1/creative-pools/{id}/items/{itemId} Update a single pool item.
CreativePoolsAPI ApiV1CreativePoolsIdItemsItemIdTogglePut Put /api/v1/creative-pools/{id}/items/{itemId}/toggle Toggle a pool item on / off.
CreativePoolsAPI ApiV1CreativePoolsIdItemsMassActionPut Put /api/v1/creative-pools/{id}/items/mass-action Bulk-change items of a creative pool.
CreativePoolsAPI ApiV1CreativePoolsIdItemsPost Post /api/v1/creative-pools/{id}/items Add an item to a creative pool.
CreativePoolsAPI ApiV1CreativePoolsIdItemsRecoverPost Post /api/v1/creative-pools/{id}/items/recover Put removed items back into a creative pool.
CreativePoolsAPI ApiV1CreativePoolsIdPut Put /api/v1/creative-pools/{id} Update creative pool meta.
CreativePoolsAPI ApiV1CreativePoolsIdRecoverPost Post /api/v1/creative-pools/{id}/recover Restore an archived creative pool.
CreativePoolsAPI ApiV1CreativePoolsIdUsedInGet Get /api/v1/creative-pools/{id}/used-in List campaigns / ads that reference this pool.
CreativePoolsAPI ApiV1CreativePoolsPost Post /api/v1/creative-pools Create a creative pool.
CreativePoolsAPI ApiV1CreativesBulkDeletePost Post /api/v1/creatives/bulk-delete Soft-delete many media-bank creatives.
CreativePoolsAPI ApiV1CreativesBulkUndeletePost Post /api/v1/creatives/bulk-undelete Restore many deleted creatives.
CreativePoolsAPI ApiV1CreativesIdUndeletePut Put /api/v1/creatives/{id}/undelete Restore one deleted creative.
CreativesAPI ApiV1CreativeFoldersGet Get /api/v1/creative-folders List media-bank folders.
CreativesAPI ApiV1CreativeFoldersIdDelete Delete /api/v1/creative-folders/{id} Delete a folder.
CreativesAPI ApiV1CreativeFoldersIdPut Put /api/v1/creative-folders/{id} Rename or move a folder.
CreativesAPI ApiV1CreativeFoldersPost Post /api/v1/creative-folders Create a folder.
CreativesAPI ApiV1CreativesBulkMovePost Post /api/v1/creatives/bulk-move File creatives into a folder.
CreativesAPI ApiV1CreativesGet Get /api/v1/creatives List the creative library.
CreativesAPI ApiV1CreativesIdDelete Delete /api/v1/creatives/{id} Delete a creative.
CreativesAPI ApiV1CreativesIdGet Get /api/v1/creatives/{id} Show one creative.
CreativesAPI ApiV1CreativesIdNamePut Put /api/v1/creatives/{id}/name Rename a creative (panel inline edit).
CreativesAPI ApiV1CreativesIdPut Put /api/v1/creatives/{id} Rename and/or re-tag a creative.
CreativesAPI ApiV1CreativesIdTagsPut Put /api/v1/creatives/{id}/tags Replace a creative's tags (panel inline edit).
CreativesAPI ApiV1CreativesIdUsedInGet Get /api/v1/creatives/{id}/used-in List ads / pools referencing this creative.
CreativesAPI ApiV1CreativesUploadPost Post /api/v1/creatives/upload Upload creative files.
DirectDealsAPI ApiV1CampaignsDirectdealIdCancelPut Put /api/v1/campaigns/directdeal/{id}/cancel Cancel a direct deal.
DirectDealsAPI ApiV1DirectDealsAdzonesGet Get /api/v1/direct-deals/adzones Ad zones a direct deal can be booked on.
DirectDealsAPI ApiV1DirectDealsGet Get /api/v1/direct-deals List direct deals with their derived status.
EventLogAPI ApiV1EventLogExportsGet Get /api/v1/event-log/exports Your event log exports, newest first.
EventLogAPI ApiV1EventLogExportsIdDownloadGet Get /api/v1/event-log/exports/{id}/download Download a finished export (.csv.gz).
EventLogAPI ApiV1EventLogExportsPost Post /api/v1/event-log/exports Queue a CSV export of your events.
EventLogAPI ApiV1EventLogGet Get /api/v1/event-log Your raw events — impressions and clicks with IP and user agent (90 days).
FiltersAPI ApiV1FiltersGet Get /api/v1/filters List all filters across types.
FiltersAPI ApiV1FiltersIpIdRangesRangeIdDelete Delete /api/v1/filters/ip/{id}/ranges/{rangeId} Delete one range from an IP pool.
FiltersAPI ApiV1FiltersIpIdRangesRangeIdTogglePut Put /api/v1/filters/ip/{id}/ranges/{rangeId}/toggle Pause / resume one range of an IP pool.
FiltersAPI ApiV1FiltersMassActionPost Post /api/v1/filters/mass-action Activate, deactivate or delete many filters.
FiltersAPI ApiV1FiltersPost Post /api/v1/filters Create a filter and populate it with items.
FiltersAPI ApiV1FiltersTypeIdActivePatch Patch /api/v1/filters/{type}/{id}/active Activate or deactivate a filter (exclusion types only).
FiltersAPI ApiV1FiltersTypeIdDelete Delete /api/v1/filters/{type}/{id} Delete a filter (and its items, for IP pools).
FiltersAPI ApiV1FiltersTypeIdGet Get /api/v1/filters/{type}/{id} Get a single filter with its items.
FiltersAPI ApiV1FiltersTypeIdItemsItemDelete Delete /api/v1/filters/{type}/{id}/items/{item} Remove a single item from a filter.
FiltersAPI ApiV1FiltersTypeIdItemsPost Post /api/v1/filters/{type}/{id}/items Add items to an existing filter.
FiltersAPI ApiV1FiltersTypeIdPut Put /api/v1/filters/{type}/{id} Edit a filter (rename, replace items, change scope).
FundsAPI ApiV1FundsBalanceSettingsPut Put /api/v1/funds/balance-settings Set the low-balance warning.
FundsAPI ApiV1FundsDepositTypeFidGet Get /api/v1/funds/deposit/{type}/{fid} Checkout data for an open deposit — or its paid state.
FundsAPI ApiV1FundsDepositTypePost Post /api/v1/funds/deposit/{type} Open a deposit (or redeem a bonus / coupon code).
FundsAPI ApiV1FundsDepositsIdDelete Delete /api/v1/funds/deposits/{id} Cancel an unpaid deposit.
FundsAPI ApiV1FundsDepositsIdProofGet Get /api/v1/funds/deposits/{id}/proof Download the proof of payment you uploaded on a deposit.
FundsAPI ApiV1FundsDepositsIdProofPost Post /api/v1/funds/deposits/{id}/proof Upload the proof of payment of an open bank or Wise deposit.
FundsAPI ApiV1FundsDepositsIdTxnHashPost Post /api/v1/funds/deposits/{id}/txn-hash Attach the transaction hash of a manual crypto deposit, or the transaction ID of a Payoneer deposit.
FundsAPI ApiV1FundsGet Get /api/v1/funds Current advertiser balance + pending deposits.
FundsAPI ApiV1FundsPayTypesGet Get /api/v1/funds/pay-types Payment methods this account can deposit with.
FundsAPI ApiV1FundsTransactionsGet Get /api/v1/funds/transactions Funds ledger — deposits, bonuses, transfers, refunds.
FundsAPI ApiV1FundsTransferPost Post /api/v1/funds/transfer Move balance to a connected advertiser account.
LookupsAPI ApiV1LookupsAdspaceTypesGet Get /api/v1/lookups/adspace-types Adspace types the caller can publish on this tenant.
LookupsAPI ApiV1LookupsAdzoneLocationsGet Get /api/v1/lookups/adzone-locations Adzone locations for the tenant.
LookupsAPI ApiV1LookupsAdzonesGet Get /api/v1/lookups/adzones Find adzone ids (for adzone filters).
LookupsAPI ApiV1LookupsBannerSizesGet Get /api/v1/lookups/banner-sizes Banner sizes for banner-flavored adspaces.
LookupsAPI ApiV1LookupsBrowsersGet Get /api/v1/lookups/browsers Browser ids (optionally scoped by device type).
LookupsAPI ApiV1LookupsCarriersGet Get /api/v1/lookups/carriers Mobile carriers (ids for carrier targeting).
LookupsAPI ApiV1LookupsCategoriesGet Get /api/v1/lookups/categories Active sub-categories (optionally scoped to a main).
LookupsAPI ApiV1LookupsDeviceTypesGet Get /api/v1/lookups/device-types Active device types for this tenant.
LookupsAPI ApiV1LookupsDomainsGet Get /api/v1/lookups/domains Resolve domains to the ids domain filters store.
LookupsAPI ApiV1LookupsIspsGet Get /api/v1/lookups/isps Find ISP ids (for ISP filters).
LookupsAPI ApiV1LookupsLinkTypesGet Get /api/v1/lookups/link-types Active link types for the tenant.
LookupsAPI ApiV1LookupsMainCategoriesGet Get /api/v1/lookups/main-categories Active main categories for the tenant.
LookupsAPI ApiV1LookupsOperatingSystemsGet Get /api/v1/lookups/operating-systems Operating-system ids (optionally scoped by device type).
LookupsAPI ApiV1LookupsPublishersGet Get /api/v1/lookups/publishers Find publisher ids (for publisher_excl filters).
LookupsAPI ApiV1LookupsRatingsGet Get /api/v1/lookups/ratings Active content ratings for the tenant.
LookupsAPI ApiV1LookupsReelTypesGet Get /api/v1/lookups/reel-types Active reel types for the tenant.
LookupsAPI ApiV1LookupsRegionsGet Get /api/v1/lookups/regions Walk the geo region tree (one level per call).
LookupsAPI ApiV1LookupsWebsiteLanguagesGet Get /api/v1/lookups/website-languages Supported website languages (ISO codes).
LookupsAPI ApiV1LookupsWebsiteTypesGet Get /api/v1/lookups/website-types Active website types for the tenant.
MarketDataAPI ApiV1PricingFiltersGet Get /api/v1/pricing/filters Labels for the pricing table's ids.
MarketDataAPI ApiV1PricingGet Get /api/v1/pricing Network floor prices (minimum bids).
MarketDataAPI ApiV1SmartNetworksGet Get /api/v1/smart-networks List the network's active smart networks.
MarketDataAPI ApiV1SmartNetworksIdGet Get /api/v1/smart-networks/{id} One smart network.
MarketDataAPI ApiV1VolumesFiltersGet Get /api/v1/volumes/filters Option lists for the volume query.
MarketDataAPI ApiV1VolumesGet Get /api/v1/volumes Available traffic volume per country (traffic estimate).
MarketplaceAPI ApiV1MarketplaceFiltersGet Get /api/v1/marketplace/filters Filter vocabulary for the marketplace.
MarketplaceAPI ApiV1MarketplaceFlatRequestsGet Get /api/v1/marketplace/flat-requests List my flat-deal requests.
MarketplaceAPI ApiV1MarketplaceFlatRequestsIdCancelPost Post /api/v1/marketplace/flat-requests/{id}/cancel Withdraw a pending flat-deal request.
MarketplaceAPI ApiV1MarketplaceFlatRequestsRenewPost Post /api/v1/marketplace/flat-requests/renew Propose one more flat deal on a live flat campaign.
MarketplaceAPI ApiV1MarketplaceGet Get /api/v1/marketplace List marketplace sites.
MarketplaceAPI ApiV1MarketplaceIdGet Get /api/v1/marketplace/{id} Ad zones of one marketplace site, with starting prices.
OAuthAPI ApiPublicIntegrationsHooksTokenPost Post /api/public/integrations/hooks/{token} Incoming webhook — create a lead, contact or task from JSON.
OAuthAPI ApiPublicOauthIntrospectPost Post /api/public/oauth/introspect Introspect one of the calling app's tokens (RFC 7662).
OAuthAPI ApiPublicOauthMetadataGet Get /api/public/oauth/metadata Authorization server metadata (RFC 8414) for this host.
OAuthAPI ApiPublicOauthRevokePost Post /api/public/oauth/revoke Revoke an access or refresh token (RFC 7009).
OAuthAPI ApiPublicOauthTokenPost Post /api/public/oauth/token Exchange an authorization code, or rotate a refresh token.
OffersAPI ApiV1OffersGet Get /api/v1/offers List available offers.
PayoutsAPI ApiV1PublisherFinanceEarningsGet Get /api/v1/publisher/finance/earnings Earnings per day, week or month.
PayoutsAPI ApiV1PublisherFinanceGet Get /api/v1/publisher/finance Publisher balance and payout rules.
PayoutsAPI ApiV1PublisherFinanceMonthEarningsGet Get /api/v1/publisher/finance/month-earnings Monthly earnings statements.
PayoutsAPI ApiV1PublisherFinancePayoutRequestPost Post /api/v1/publisher/finance/payout-request Request a payout of the balance.
PayoutsAPI ApiV1PublisherFinancePayoutTypesGet Get /api/v1/publisher/finance/payout-types Payout methods this account may choose.
PayoutsAPI ApiV1PublisherFinancePayoutsGet Get /api/v1/publisher/finance/payouts List payout requests and payouts.
PayoutsAPI ApiV1PublisherFinanceSettingsGet Get /api/v1/publisher/finance/settings Payout method and payment details.
PayoutsAPI ApiV1PublisherFinanceSettingsPut Put /api/v1/publisher/finance/settings Change the payout method or payment details.
PayoutsAPI ApiV1PublisherFinanceTransactionsGet Get /api/v1/publisher/finance/transactions List payout transactions (with USD totals).
PayoutsAPI ApiV1PublisherFinanceTransactionsIdGet Get /api/v1/publisher/finance/transactions/{id} One payout transaction.
PayoutsAPI ApiV1PublisherFinanceTransactionsIdInvoicePdfGet Get /api/v1/publisher/finance/transactions/{id}/invoice-pdf Download the self-billing invoice PDF of a paid payout.
PayoutsAPI ApiV1PublisherFinanceTransferToAdvertiserPost Post /api/v1/publisher/finance/transfer-to-advertiser Move publisher balance to the advertiser budget.
ProductFeedsAPI ApiV1ProductFeedsGet Get /api/v1/product-feeds List product feeds.
ProductFeedsAPI ApiV1ProductFeedsIdDelete Delete /api/v1/product-feeds/{id} Delete a product feed.
ProductFeedsAPI ApiV1ProductFeedsIdGet Get /api/v1/product-feeds/{id} Show a product feed.
ProductFeedsAPI ApiV1ProductFeedsIdItemsGet Get /api/v1/product-feeds/{id}/items The feed's products and their ads.
ProductFeedsAPI ApiV1ProductFeedsIdPatch Patch /api/v1/product-feeds/{id} Change a product feed.
ProductFeedsAPI ApiV1ProductFeedsIdSyncPost Post /api/v1/product-feeds/{id}/sync Sync a product feed now.
ProductFeedsAPI ApiV1ProductFeedsPost Post /api/v1/product-feeds Add a product feed.
ProductFeedsAPI ApiV1ProductFeedsPreviewPost Post /api/v1/product-feeds/preview Preview a dynamic banner.
PublicAPI ApiPublicDemoGet Get /api/public/demo The network's ad format demo pages.
PublicAPI ApiPublicDemoSlugGet Get /api/public/demo/{slug} One ad format demo page (HTML).
PublicAPI ApiPublicOfferwallIdGet Get /api/public/offerwall/{id} Offerwall list of an offer zone.
PublicAPI ApiPublicOpenapiJsonGet Get /api/public/openapi.json OpenAPI spec as JSON.
PublicAPI ApiPublicOpenapiYamlGet Get /api/public/openapi.yaml Raw OpenAPI spec (this document).
PublicAPI ApiPublicRoutesTxtGet Get /api/public/routes.txt Flat list of public routes — agent-friendly.
PublisherFiltersAPI ApiV1PublisherFiltersGet Get /api/v1/publisher/filters List the publisher's URL block list.
PublisherFiltersAPI ApiV1PublisherFiltersUrlsDelete Delete /api/v1/publisher/filters/urls Remove one or more URLs from the block list.
PublisherFiltersAPI ApiV1PublisherFiltersUrlsPost Post /api/v1/publisher/filters/urls Add one or more URLs to the block list.
PushAudienceAPI ApiV1PublisherPushDeliveryRulesGet Get /api/v1/publisher/push-delivery-rules List standing delivery rules.
PushAudienceAPI ApiV1PublisherPushDeliveryRulesIdDelete Delete /api/v1/publisher/push-delivery-rules/{id} Delete a delivery rule.
PushAudienceAPI ApiV1PublisherPushDeliveryRulesIdPut Put /api/v1/publisher/push-delivery-rules/{id} Update a delivery rule.
PushAudienceAPI ApiV1PublisherPushDeliveryRulesPost Post /api/v1/publisher/push-delivery-rules Create a delivery rule.
PushAudienceAPI ApiV1PublisherPushSegmentsGet Get /api/v1/publisher/push-segments List saved audience segments.
PushAudienceAPI ApiV1PublisherPushSegmentsIdDelete Delete /api/v1/publisher/push-segments/{id} Delete an audience segment.
PushAudienceAPI ApiV1PublisherPushSegmentsIdPut Put /api/v1/publisher/push-segments/{id} Update an audience segment.
PushAudienceAPI ApiV1PublisherPushSegmentsPost Post /api/v1/publisher/push-segments Create an audience segment.
PushAudienceAPI ApiV1PublisherPushSetupGet Get /api/v1/publisher/push-setup Collector setup facts for the opt-in script.
PushAudienceAPI ApiV1PublisherPushStatsGet Get /api/v1/publisher/push-stats Push delivery performance.
PushAudienceAPI ApiV1PublisherPushSubscribersActionPost Post /api/v1/publisher/push-subscribers/action Activate, deactivate or delete subscribers in bulk.
PushAudienceAPI ApiV1PublisherPushSubscribersGet Get /api/v1/publisher/push-subscribers List captured push subscribers.
PushCampaignsAPI ApiV1PublisherPushCampaignsGet Get /api/v1/publisher/push-campaigns List the caller's push campaigns.
PushCampaignsAPI ApiV1PublisherPushCampaignsIdDelete Delete /api/v1/publisher/push-campaigns/{id} Delete a push campaign.
PushCampaignsAPI ApiV1PublisherPushCampaignsIdPut Put /api/v1/publisher/push-campaigns/{id} Update a push campaign's notification content.
PushCampaignsAPI ApiV1PublisherPushCampaignsIdSendPost Post /api/v1/publisher/push-campaigns/{id}/send Queue a push campaign for delivery.
PushCampaignsAPI ApiV1PublisherPushCampaignsPost Post /api/v1/publisher/push-campaigns Create a push campaign.
RetargetingAPI ApiV1RetargetingPixelsGet Get /api/v1/retargeting/pixels List the caller's retargeting pixels.
RetargetingAPI ApiV1RetargetingPixelsIdActivePatch Patch /api/v1/retargeting/pixels/{id}/active Activate or deactivate a retargeting pixel.
RetargetingAPI ApiV1RetargetingPixelsIdDelete Delete /api/v1/retargeting/pixels/{id} Soft-delete a retargeting pixel and clear its captured visitors.
RetargetingAPI ApiV1RetargetingPixelsIdGet Get /api/v1/retargeting/pixels/{id} Get one retargeting pixel.
RetargetingAPI ApiV1RetargetingPixelsIdPut Put /api/v1/retargeting/pixels/{id} Update a retargeting pixel (name and visitor windows).
RetargetingAPI ApiV1RetargetingPixelsPost Post /api/v1/retargeting/pixels Create a retargeting pixel.
SSPCampaignsAPI ApiV1PublisherSspCampaignsGet Get /api/v1/publisher/ssp/campaigns List SSP campaigns (feeds).
SSPCampaignsAPI ApiV1PublisherSspCampaignsIdClonePost Post /api/v1/publisher/ssp/campaigns/{id}/clone Clone an SSP campaign.
SSPCampaignsAPI ApiV1PublisherSspCampaignsIdGet Get /api/v1/publisher/ssp/campaigns/{id} Get one SSP campaign.
SSPCampaignsAPI ApiV1PublisherSspCampaignsIdPut Put /api/v1/publisher/ssp/campaigns/{id} Update an SSP campaign.
SSPCampaignsAPI ApiV1PublisherSspCampaignsIdTestRtbGet Get /api/v1/publisher/ssp/campaigns/{id}/test-rtb Context for an RTB test request.
SSPCampaignsAPI ApiV1PublisherSspCampaignsIdTestRtbPost Post /api/v1/publisher/ssp/campaigns/{id}/test-rtb Send one test bid request to the feed's endpoint.
SSPCampaignsAPI ApiV1PublisherSspCampaignsIdToggleDeletePut Put /api/v1/publisher/ssp/campaigns/{id}/toggle-delete Delete or restore an SSP campaign.
SSPCampaignsAPI ApiV1PublisherSspCampaignsIdTogglePausePut Put /api/v1/publisher/ssp/campaigns/{id}/toggle-pause Pause or resume an SSP campaign.
SSPCampaignsAPI ApiV1PublisherSspCampaignsIdWlRonCampaignsGet Get /api/v1/publisher/ssp/campaigns/{id}/wl-ron-campaigns RON campaigns that can be whitelisted on a feed.
SSPCampaignsAPI ApiV1PublisherSspCampaignsPost Post /api/v1/publisher/ssp/campaigns Create an SSP campaign.
SSPCampaignsAPI ApiV1PublisherSspCampaignsSetupDataGet Get /api/v1/publisher/ssp/campaigns/setup-data Lookups for the SSP campaign form.
SSPCampaignsAPI ApiV1PublisherSspFiltersGet Get /api/v1/publisher/ssp/filters Filter values for the SSP campaign list.
SSPCampaignsAPI ApiV1PublisherSspNetworksGet Get /api/v1/publisher/ssp/networks RTB networks your SSP campaigns use.
SSPCampaignsAPI ApiV1PublisherSspSellerDisclosurePut Put /api/v1/publisher/ssp/seller-disclosure Publish or hide your name in sellers.json.
SSPCampaignsAPI ApiV1PublisherSspSitesIdAdsTxtCheckPost Post /api/v1/publisher/ssp/sites/{id}/ads-txt-check Re-check a site's ads.txt now.
SSPCampaignsAPI ApiV1PublisherSspSitesIdAdsTxtStatusGet Get /api/v1/publisher/ssp/sites/{id}/ads-txt-status Last stored ads.txt check for a site.
SharedReportsAPI ApiV1SharedReportsGet Get /api/v1/shared-reports List shared reports.
SharedReportsAPI ApiV1SharedReportsIdDelete Delete /api/v1/shared-reports/{id} Delete a shared report.
SharedReportsAPI ApiV1SharedReportsIdGet Get /api/v1/shared-reports/{id} Show a shared report.
SharedReportsAPI ApiV1SharedReportsIdPut Put /api/v1/shared-reports/{id} Update a shared report.
SharedReportsAPI ApiV1SharedReportsIdToggleActivePut Put /api/v1/shared-reports/{id}/toggle-active Switch a report's link on or off.
SharedReportsAPI ApiV1SharedReportsPost Post /api/v1/shared-reports Create a shared report.
SharedReportsAPI ApiV1SharedReportsSetupDataGet Get /api/v1/shared-reports/setup-data Campaigns and sites a report can cover.
SitesAPI ApiV1DomainsGet Get /api/v1/domains List your custom domains (Domain Manager).
SitesAPI ApiV1DomainsIdDelete Delete /api/v1/domains/{id} Delete a custom domain.
SitesAPI ApiV1DomainsIdGet Get /api/v1/domains/{id} Show one custom domain.
SitesAPI ApiV1DomainsIdNotesPut Put /api/v1/domains/{id}/notes Set your notes on a domain.
SitesAPI ApiV1DomainsIdRedoPost Post /api/v1/domains/{id}/redo Retry setting up a domain (DNS / certificate check again).
SitesAPI ApiV1DomainsIdToggleActivePost Post /api/v1/domains/{id}/toggle-active Switch a custom domain on or off.
SitesAPI ApiV1DomainsPost Post /api/v1/domains Add a custom domain.
SitesAPI ApiV1SitesGet Get /api/v1/sites List the caller's websites.
SitesAPI ApiV1SitesIdClonePost Post /api/v1/sites/{id}/clone Duplicate a site under a new name and URL, with its ad zones.
SitesAPI ApiV1SitesIdDelete Delete /api/v1/sites/{id} Soft-delete a site.
SitesAPI ApiV1SitesIdGet Get /api/v1/sites/{id} Get a single site.
SitesAPI ApiV1SitesIdPatch Patch /api/v1/sites/{id} Update a site.
SitesAPI ApiV1SitesIdRecoverPost Post /api/v1/sites/{id}/recover Reverse a soft-delete on a site.
SitesAPI ApiV1SitesIdSnippetsGet Get /api/v1/sites/{id}/snippets List the site's HTML snippets.
SitesAPI ApiV1SitesIdSnippetsPost Post /api/v1/sites/{id}/snippets Add an HTML snippet.
SitesAPI ApiV1SitesIdSnippetsSnippetIdDelete Delete /api/v1/sites/{id}/snippets/{snippetId} Delete an HTML snippet.
SitesAPI ApiV1SitesIdSnippetsSnippetIdPut Put /api/v1/sites/{id}/snippets/{snippetId} Replace an HTML snippet.
SitesAPI ApiV1SitesIdVerifyPost Post /api/v1/sites/{id}/verify Trigger HTTP re-check of the site verification meta tag.
SitesAPI ApiV1SitesPost Post /api/v1/sites Create a new website.
SitesAPI ApiV1SitesSchemaGet Get /api/v1/sites/_schema Field metadata for site create/update.
SmartZonesAPI ApiV1PublisherSmartzonesDistributionAdspacesIdGet Get /api/v1/publisher/smartzones/distribution/adspaces/{id} Network split for one ad zone.
SmartZonesAPI ApiV1PublisherSmartzonesDistributionPerSiteGet Get /api/v1/publisher/smartzones/distribution/per-site Traffic and earnings split across networks for one site.
SmartZonesAPI ApiV1PublisherSmartzonesDistributionSitesGet Get /api/v1/publisher/smartzones/distribution/sites Sites that carry smart zones.
SmartZonesAPI ApiV1PublisherSmartzonesGet Get /api/v1/publisher/smartzones List smart zones.
SmartZonesAPI ApiV1PublisherSmartzonesIdDelete Delete /api/v1/publisher/smartzones/{id} Delete a smart zone.
SmartZonesAPI ApiV1PublisherSmartzonesIdGet Get /api/v1/publisher/smartzones/{id} Get one smart zone.
SmartZonesAPI ApiV1PublisherSmartzonesIdPut Put /api/v1/publisher/smartzones/{id} Update a smart zone.
SmartZonesAPI ApiV1PublisherSmartzonesImportPost Post /api/v1/publisher/smartzones/import Bulk import smart zones.
SmartZonesAPI ApiV1PublisherSmartzonesNetworksGet Get /api/v1/publisher/smartzones/networks List your smart network accounts.
SmartZonesAPI ApiV1PublisherSmartzonesNetworksIdDelete Delete /api/v1/publisher/smartzones/networks/{id} Remove a smart network account.
SmartZonesAPI ApiV1PublisherSmartzonesNetworksPost Post /api/v1/publisher/smartzones/networks Add or update a smart network account.
SmartZonesAPI ApiV1PublisherSmartzonesPost Post /api/v1/publisher/smartzones Create a smart zone.
SmartZonesAPI ApiV1PublisherSmartzonesSetupDataGet Get /api/v1/publisher/smartzones/setup-data Lookups for the smart-zone form.
SmartZonesAPI ApiV1PublisherSmartzonesSspCampaignsGet Get /api/v1/publisher/smartzones/ssp-campaigns SSP campaigns usable as a smart zone's RTB feed.
SourceOptimizersAPI ApiV1CpaOptimizersGet Get /api/v1/cpa-optimizers List CPA optimizers.
SourceOptimizersAPI ApiV1CpaOptimizersIdDelete Delete /api/v1/cpa-optimizers/{id} Delete a CPA optimizer.
SourceOptimizersAPI ApiV1CpaOptimizersIdGet Get /api/v1/cpa-optimizers/{id} Show a CPA optimizer.
SourceOptimizersAPI ApiV1CpaOptimizersIdPut Put /api/v1/cpa-optimizers/{id} Replace a CPA optimizer.
SourceOptimizersAPI ApiV1CpaOptimizersPost Post /api/v1/cpa-optimizers Create a CPA optimizer.
SourceOptimizersAPI ApiV1CpmOptimizersActiveGet Get /api/v1/cpm-optimizers/active Does the account have any CPM optimizer?
SourceOptimizersAPI ApiV1CpmOptimizersGet Get /api/v1/cpm-optimizers List CPM optimizers.
SourceOptimizersAPI ApiV1CpmOptimizersIdDelete Delete /api/v1/cpm-optimizers/{id} Delete a CPM optimizer.
SourceOptimizersAPI ApiV1CpmOptimizersIdGet Get /api/v1/cpm-optimizers/{id} Show a CPM optimizer.
SourceOptimizersAPI ApiV1CpmOptimizersIdPut Put /api/v1/cpm-optimizers/{id} Replace a CPM optimizer.
SourceOptimizersAPI ApiV1CpmOptimizersPost Post /api/v1/cpm-optimizers Create a CPM optimizer.
SourceOptimizersAPI ApiV1SourceOptimizerConfigGet Get /api/v1/source-optimizer/config Option values for the optimizer forms.
StatsAdvertiserAPI ApiV1AdvertiserStatsGet Get /api/v1/advertiser/stats Display, native and CPM/RON campaign stats.
StatsAdvertiserOffersAPI ApiV1AdvertiserOffersStatsGet Get /api/v1/advertiser/offers/stats CPA / affiliate offer performance — advertiser side.
StatsAdvertiserRTBAPI ApiV1AdvertiserRtbStatsGet Get /api/v1/advertiser/rtb/stats DSP / RTB-side stats.
StatsAffiliateAPI ApiV1PublisherOffersPostbackLogGet Get /api/v1/publisher/offers/postback-log Postback log — the conversion postbacks fired to your URLs.
StatsAffiliateAPI ApiV1PublisherOffersStatsGet Get /api/v1/publisher/offers/stats Affiliate / smartlink offer performance — publisher side.
StatsPublisherAPI ApiV1PublisherStatsGet Get /api/v1/publisher/stats Publisher earnings (sites / adzones).
StatsPublisherSSPAPI ApiV1PublisherSspStatsDetailsGet Get /api/v1/publisher/ssp/stats/details SSP report broken down by one dimension.
StatsPublisherSSPAPI ApiV1PublisherSspStatsFiltersGet Get /api/v1/publisher/ssp/stats/filters Filter values for the SSP reports.
StatsPublisherSSPAPI ApiV1PublisherSspStatsFlatGet Get /api/v1/publisher/ssp/stats/flat SSP report grouped by several dimensions.
StatsPublisherSSPAPI ApiV1PublisherSspStatsGet Get /api/v1/publisher/ssp/stats SSP / smart-campaign earnings.
StatsPublisherSmartZonesAPI ApiV1PublisherSmartzonesStatsFiltersGet Get /api/v1/publisher/smartzones/stats/filters Filter values for smart-zone stats.
StatsPublisherSmartZonesAPI ApiV1PublisherSmartzonesStatsGet Get /api/v1/publisher/smartzones/stats SmartZone (waterfall) earnings.
TagsAPI ApiV1TagsGet Get /api/v1/tags List tags.
TagsAPI ApiV1TagsIdDelete Delete /api/v1/tags/{id} Delete a tag.
TagsAPI ApiV1TagsIdGet Get /api/v1/tags/{id} Show a tag.
TagsAPI ApiV1TagsIdPut Put /api/v1/tags/{id} Rename or move a tag.
TagsAPI ApiV1TagsMassDeletePost Post /api/v1/tags/mass-delete Delete several tags.
TagsAPI ApiV1TagsPost Post /api/v1/tags Create a tag.
TrackerAutomationAPI ApiV1TrackerExportTypeGet Get /api/v1/tracker/export/{type} Export tracker entities as CSV.
TrackerAutomationAPI ApiV1TrackerImportTypePost Post /api/v1/tracker/import/{type} Bulk-import offers from CSV.
TrackerAutomationAPI ApiV1TrackerReportSchedulesGet Get /api/v1/tracker/report-schedules List scheduled report deliveries.
TrackerAutomationAPI ApiV1TrackerReportSchedulesIdDelete Delete /api/v1/tracker/report-schedules/{id} Delete a report schedule.
TrackerAutomationAPI ApiV1TrackerReportSchedulesIdGet Get /api/v1/tracker/report-schedules/{id} Get one report schedule.
TrackerAutomationAPI ApiV1TrackerReportSchedulesIdPut Put /api/v1/tracker/report-schedules/{id} Update a report schedule.
TrackerAutomationAPI ApiV1TrackerReportSchedulesPost Post /api/v1/tracker/report-schedules Schedule a recurring report.
TrackerAutomationAPI ApiV1TrackerRulesGet Get /api/v1/tracker/rules List automation rules.
TrackerAutomationAPI ApiV1TrackerRulesIdDelete Delete /api/v1/tracker/rules/{id} Delete a rule.
TrackerAutomationAPI ApiV1TrackerRulesIdExecutionsGet Get /api/v1/tracker/rules/{id}/executions Execution history for one rule.
TrackerAutomationAPI ApiV1TrackerRulesIdGet Get /api/v1/tracker/rules/{id} Get one rule.
TrackerAutomationAPI ApiV1TrackerRulesIdPut Put /api/v1/tracker/rules/{id} Update a rule.
TrackerAutomationAPI ApiV1TrackerRulesIdRunPost Post /api/v1/tracker/rules/{id}/run Run a rule now.
TrackerAutomationAPI ApiV1TrackerRulesPost Post /api/v1/tracker/rules Create an automation rule.
TrackerConversionsAPI ApiV1TrackerConversionLoggingGet Get /api/v1/tracker/conversion-logging Get conversion-logging settings.
TrackerConversionsAPI ApiV1TrackerConversionLoggingPut Put /api/v1/tracker/conversion-logging Change conversion-logging settings.
TrackerConversionsAPI ApiV1TrackerConversionTypesGet Get /api/v1/tracker/conversion-types Get the conversion-type labels.
TrackerConversionsAPI ApiV1TrackerConversionTypesPut Put /api/v1/tracker/conversion-types Rename the conversion types.
TrackerConversionsAPI ApiV1TrackerConversionsClickidPostbacksGet Get /api/v1/tracker/conversions/{clickid}/postbacks Outbound postbacks fired for one conversion.
TrackerConversionsAPI ApiV1TrackerConversionsGet Get /api/v1/tracker/conversions List incoming conversions.
TrackerConversionsAPI ApiV1TrackerConversionsIdStatePut Put /api/v1/tracker/conversions/{id}/state Approve or reject one conversion.
TrackerConversionsAPI ApiV1TrackerConversionsRejectedGet Get /api/v1/tracker/conversions/rejected List refused inbound postbacks.
TrackerNetworksAPI ApiV1TrackerAdNetworksDeleteReportsPut Put /api/v1/tracker/ad-networks/delete-reports Delete pulled spend reports.
TrackerNetworksAPI ApiV1TrackerAdNetworksGet Get /api/v1/tracker/ad-networks List ad networks.
TrackerNetworksAPI ApiV1TrackerAdNetworksIdCampaignsGet Get /api/v1/tracker/ad-networks/{id}/campaigns Campaigns known on one ad network.
TrackerNetworksAPI ApiV1TrackerAdNetworksIdDelete Delete /api/v1/tracker/ad-networks/{id} Delete an ad network.
TrackerNetworksAPI ApiV1TrackerAdNetworksIdGet Get /api/v1/tracker/ad-networks/{id} Get one ad network.
TrackerNetworksAPI ApiV1TrackerAdNetworksIdPut Put /api/v1/tracker/ad-networks/{id} Update an ad network.
TrackerNetworksAPI ApiV1TrackerAdNetworksPost Post /api/v1/tracker/ad-networks Create an ad network.
TrackerNetworksAPI ApiV1TrackerAdNetworksReportsGet Get /api/v1/tracker/ad-networks/reports Spend reports pulled from the ad networks.
TrackerNetworksAPI ApiV1TrackerAffiliateNetworkTemplatesGet Get /api/v1/tracker/affiliate-network-templates List affiliate-network templates.
TrackerNetworksAPI ApiV1TrackerAffiliateNetworksGet Get /api/v1/tracker/affiliate-networks List affiliate networks.
TrackerNetworksAPI ApiV1TrackerAffiliateNetworksIdDelete Delete /api/v1/tracker/affiliate-networks/{id} Delete an affiliate network.
TrackerNetworksAPI ApiV1TrackerAffiliateNetworksIdPut Put /api/v1/tracker/affiliate-networks/{id} Update an affiliate network.
TrackerNetworksAPI ApiV1TrackerAffiliateNetworksPost Post /api/v1/tracker/affiliate-networks Create an affiliate network.
TrackerOffersAPI ApiV1TrackerOffersBulkPost Post /api/v1/tracker/offers/bulk Pause, activate or delete many offers.
TrackerOffersAPI ApiV1TrackerOffersGet Get /api/v1/tracker/offers List tracker offers.
TrackerOffersAPI ApiV1TrackerOffersIdDelete Delete /api/v1/tracker/offers/{id} Delete an offer.
TrackerOffersAPI ApiV1TrackerOffersIdGet Get /api/v1/tracker/offers/{id} Get one offer.
TrackerOffersAPI ApiV1TrackerOffersIdPut Put /api/v1/tracker/offers/{id} Update an offer.
TrackerOffersAPI ApiV1TrackerOffersIdUrlsPost Post /api/v1/tracker/offers/{id}/urls Add a landing URL to an offer.
TrackerOffersAPI ApiV1TrackerOffersIdUrlsUrlIdDelete Delete /api/v1/tracker/offers/{id}/urls/{urlId} Delete one landing URL.
TrackerOffersAPI ApiV1TrackerOffersIdUrlsUrlIdPut Put /api/v1/tracker/offers/{id}/urls/{urlId} Update one landing URL.
TrackerOffersAPI ApiV1TrackerOffersPost Post /api/v1/tracker/offers Create an offer.
TrackerReportsAPI ApiV1TrackerCostSummaryGet Get /api/v1/tracker/cost-summary Spend against revenue.
TrackerReportsAPI ApiV1TrackerDailyStatsGet Get /api/v1/tracker/daily-stats Daily performance, filtered.
TrackerReportsAPI ApiV1TrackerInlineStatsGet Get /api/v1/tracker/inline-stats Per-row performance for a listing.
TrackerReportsAPI ApiV1TrackerPlayerLtvGet Get /api/v1/tracker/player-ltv Lifetime value by cohort.
TrackerReportsAPI ApiV1TrackerPostbacksStatsGet Get /api/v1/tracker/postbacks/stats Outbound postback firing log.
TrackerReportsAPI ApiV1TrackerRecentClicksGet Get /api/v1/tracker/recent-clicks The most recent clicks.
TrackerSettingsAPI ApiV1TrackerCountriesGet Get /api/v1/tracker/countries List countries seen in the caller's traffic.
TrackerSettingsAPI ApiV1TrackerCustomParamsGet Get /api/v1/tracker/custom-params Get the custom-parameter slots.
TrackerSettingsAPI ApiV1TrackerCustomParamsPut Put /api/v1/tracker/custom-params Name the custom-parameter slots.
TrackerSettingsAPI ApiV1TrackerSettingsGet Get /api/v1/tracker/settings Tracker settings for this account.
TrackerSettingsAPI ApiV1TrackerSourceTemplatesGet Get /api/v1/tracker/source-templates List traffic-source templates.
TrackerSettingsAPI ApiV1TrackerTokensGet Get /api/v1/tracker/tokens List the macro tokens.
TrackerSourcesAPI ApiV1TrackerCostDriversGet Get /api/v1/tracker/cost-drivers List available cost drivers.
TrackerSourcesAPI ApiV1TrackerSourceAccountsGet Get /api/v1/tracker/source-accounts List connected ad accounts.
TrackerSourcesAPI ApiV1TrackerSourceAccountsIdCampaignsGet Get /api/v1/tracker/source-accounts/{id}/campaigns Campaigns visible in a connected ad account.
TrackerSourcesAPI ApiV1TrackerSourceAccountsIdDelete Delete /api/v1/tracker/source-accounts/{id} Disconnect an ad account.
TrackerSourcesAPI ApiV1TrackerSourceAccountsIdGet Get /api/v1/tracker/source-accounts/{id} Get one connected ad account.
TrackerSourcesAPI ApiV1TrackerSourceAccountsIdPut Put /api/v1/tracker/source-accounts/{id} Update a connected ad account.
TrackerSourcesAPI ApiV1TrackerSourceAccountsIdSyncPost Post /api/v1/tracker/source-accounts/{id}/sync Pull spend from a connected ad account now.
TrackerSourcesAPI ApiV1TrackerSourceAccountsPost Post /api/v1/tracker/source-accounts Connect an ad account.
TrackerSourcesAPI ApiV1TrackerSourcesGet Get /api/v1/tracker/sources List traffic sources.
TrackerSourcesAPI ApiV1TrackerSourcesIdDelete Delete /api/v1/tracker/sources/{id} Delete a traffic source.
TrackerSourcesAPI ApiV1TrackerSourcesIdPut Put /api/v1/tracker/sources/{id} Update a traffic source.
TrackerSourcesAPI ApiV1TrackerSourcesPost Post /api/v1/tracker/sources Create a traffic source.
TrackerSourcesAPI ApiV1TrackerSourcesSiteidCampaignsGet Get /api/v1/tracker/sources/{siteid}/campaigns Campaigns reported by a source's connected ad account.
TrackerTrackingLinksAPI ApiV1TrackerTrackingLinksBulkPost Post /api/v1/tracker/tracking-links/bulk Delete many tracking links.
TrackerTrackingLinksAPI ApiV1TrackerTrackingLinksGet Get /api/v1/tracker/tracking-links List tracking links.
TrackerTrackingLinksAPI ApiV1TrackerTrackingLinksIdBlocklistGet Get /api/v1/tracker/tracking-links/{id}/blocklist List zones blocked on one link.
TrackerTrackingLinksAPI ApiV1TrackerTrackingLinksIdBlocklistPost Post /api/v1/tracker/tracking-links/{id}/blocklist Block a zone on one link.
TrackerTrackingLinksAPI ApiV1TrackerTrackingLinksIdBlocklistZoneIdDelete Delete /api/v1/tracker/tracking-links/{id}/blocklist/{zoneId} Unblock a zone on one link.
TrackerTrackingLinksAPI ApiV1TrackerTrackingLinksIdDelete Delete /api/v1/tracker/tracking-links/{id} Delete a tracking link.
TrackerTrackingLinksAPI ApiV1TrackerTrackingLinksIdNetworkBindingDelete Delete /api/v1/tracker/tracking-links/{id}/network-binding Unbind a tracking link from its ad-network campaign.
TrackerTrackingLinksAPI ApiV1TrackerTrackingLinksIdNetworkBindingPut Put /api/v1/tracker/tracking-links/{id}/network-binding Bind a tracking link to an ad-network campaign.
TrackerTrackingLinksAPI ApiV1TrackerTrackingLinksIdPut Put /api/v1/tracker/tracking-links/{id} Update a tracking link.
TrackerTrackingLinksAPI ApiV1TrackerTrackingLinksIdToggleActivePost Post /api/v1/tracker/tracking-links/{id}/toggle-active Pause or resume the bound network campaign.
TrackerTrackingLinksAPI ApiV1TrackerTrackingLinksIdZoneCostsGet Get /api/v1/tracker/tracking-links/{id}/zone-costs Per-zone cost and performance for one link.
TrackerTrackingLinksAPI ApiV1TrackerTrackingLinksPost Post /api/v1/tracker/tracking-links Create a tracking link.
TrackingAPI ApiV1TrackingConversionTypesGet Get /api/v1/tracking/conversion-types Available conversion types for the caller's account.
TrackingAPI ApiV1TrackingConversionTypesPut Put /api/v1/tracking/conversion-types Name conversion-type slots and set the click-id dedup opt-outs.
TrackingAPI ApiV1TrackingPixelsGet Get /api/v1/tracking/pixels Deprecated: List the caller's conversion-tracking pixels.
TrackingAPI ApiV1TrackingPixelsIdDelete Delete /api/v1/tracking/pixels/{id} Deprecated: Delete a pixel.
TrackingAPI ApiV1TrackingPixelsIdGet Get /api/v1/tracking/pixels/{id} Deprecated: Get one pixel.
TrackingAPI ApiV1TrackingPixelsIdPut Put /api/v1/tracking/pixels/{id} Deprecated: Update a pixel's name or conversion type.
TrackingAPI ApiV1TrackingPixelsPost Post /api/v1/tracking/pixels Deprecated: Create a new tracking pixel.
URLPoolsAPI ApiV1UrlPoolsGet Get /api/v1/url-pools List URL pools.
URLPoolsAPI ApiV1UrlPoolsIdClonePost Post /api/v1/url-pools/{id}/clone Clone a URL pool with all its URLs.
URLPoolsAPI ApiV1UrlPoolsIdDelete Delete /api/v1/url-pools/{id} Soft-delete a URL pool.
URLPoolsAPI ApiV1UrlPoolsIdGet Get /api/v1/url-pools/{id} Show one URL pool.
URLPoolsAPI ApiV1UrlPoolsIdPut Put /api/v1/url-pools/{id} Update URL pool meta.
URLPoolsAPI ApiV1UrlPoolsIdRecoverPost Post /api/v1/url-pools/{id}/recover Restore an archived url pool.
URLPoolsAPI ApiV1UrlPoolsIdUrlsGet Get /api/v1/url-pools/{id}/urls List URLs in a pool.
URLPoolsAPI ApiV1UrlPoolsIdUrlsPost Post /api/v1/url-pools/{id}/urls Add a URL to a pool.
URLPoolsAPI ApiV1UrlPoolsIdUrlsUrlIdClonePost Post /api/v1/url-pools/{id}/urls/{urlId}/clone Clone a single URL within the same pool.
URLPoolsAPI ApiV1UrlPoolsIdUrlsUrlIdDelete Delete /api/v1/url-pools/{id}/urls/{urlId} Soft-delete a single URL.
URLPoolsAPI ApiV1UrlPoolsIdUrlsUrlIdGet Get /api/v1/url-pools/{id}/urls/{urlId} Show a single URL.
URLPoolsAPI ApiV1UrlPoolsIdUrlsUrlIdPut Put /api/v1/url-pools/{id}/urls/{urlId} Update a single URL.
URLPoolsAPI ApiV1UrlPoolsIdUrlsUrlIdTogglePut Put /api/v1/url-pools/{id}/urls/{urlId}/toggle Toggle a URL on / off.
URLPoolsAPI ApiV1UrlPoolsIdUrlsUrlIdWeightPut Put /api/v1/url-pools/{id}/urls/{urlId}/weight Set a URL's rotation weight.
URLPoolsAPI ApiV1UrlPoolsIdUsedInGet Get /api/v1/url-pools/{id}/used-in List campaigns / ads that reference this URL pool.
URLPoolsAPI ApiV1UrlPoolsPost Post /api/v1/url-pools Create a URL pool.
URLPoolsAPI ApiV1UrlPoolsReplaceUrlPut Put /api/v1/url-pools/replace-url Search & replace text across your URL-pool URLs.
WebhooksEventsAPI ApiV1EventsGet Get /api/v1/events Read the account's event feed.
WebhooksEventsAPI ApiV1WebhooksGet Get /api/v1/webhooks List webhooks.
WebhooksEventsAPI ApiV1WebhooksIdDelete Delete /api/v1/webhooks/{id} Remove a webhook.
WebhooksEventsAPI ApiV1WebhooksIdDeliveriesDeliveryRedeliverPost Post /api/v1/webhooks/{id}/deliveries/{delivery}/redeliver Send a delivery again.
WebhooksEventsAPI ApiV1WebhooksIdDeliveriesGet Get /api/v1/webhooks/{id}/deliveries List a webhook's deliveries.
WebhooksEventsAPI ApiV1WebhooksIdGet Get /api/v1/webhooks/{id} Get one webhook.
WebhooksEventsAPI ApiV1WebhooksIdPatch Patch /api/v1/webhooks/{id} Edit, pause or resume a webhook.
WebhooksEventsAPI ApiV1WebhooksIdRotateSecretPost Post /api/v1/webhooks/{id}/rotate-secret Issue a new signing secret.
WebhooksEventsAPI ApiV1WebhooksIdTestPost Post /api/v1/webhooks/{id}/test Send a test ping.
WebhooksEventsAPI ApiV1WebhooksPost Post /api/v1/webhooks Create a webhook.
XMLFeedsAPI ApiV1XmlFeedsGet Get /api/v1/xml-feeds List XML feeds.
XMLFeedsAPI ApiV1XmlFeedsIdClonePost Post /api/v1/xml-feeds/{id}/clone Clone an XML feed.
XMLFeedsAPI ApiV1XmlFeedsIdDelete Delete /api/v1/xml-feeds/{id} Delete an XML feed.
XMLFeedsAPI ApiV1XmlFeedsIdGet Get /api/v1/xml-feeds/{id} Show an XML feed.
XMLFeedsAPI ApiV1XmlFeedsIdPut Put /api/v1/xml-feeds/{id} Update an XML feed.
XMLFeedsAPI ApiV1XmlFeedsIdTogglePut Put /api/v1/xml-feeds/{id}/toggle Flip an XML feed active / paused.
XMLFeedsAPI ApiV1XmlFeedsPost Post /api/v1/xml-feeds Create an XML feed.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

apiKey

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), goadserver.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

oauth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: /oauth/authorize
  • Scopes:
  • campaigns.read: View campaigns
  • campaigns.write: View and change campaigns
  • stats.read: View stats
  • sites.read: View sites
  • adspaces.read: View adspaces
  • payouts.read: View publisher earnings and payouts
  • billing.read: View billing
  • webhooks.read: View webhooks and the event feed
  • webhooks.write: Manage webhooks

Example

auth := context.WithValue(context.Background(), goadserver.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, goadserver.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

About

Official Go client for the GoAdserver REST API

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages