Skip to content

About

Official JavaScript/TypeScript client for the GoAdserver REST API

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

goadserver-sdk@1.1.0

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

A TypeScript SDK client for the up.go-adserver.com API.

Usage

First, install the SDK from npm.

npm install goadserver-sdk --save

Next, try it out.

import {
  Configuration,
  AIAssistantApi,
} from 'goadserver-sdk';
import type { ApiV1McpPostOperationRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new AIAssistantApi(config);

  const body = {
    // ApiV1McpPostRequest
    apiV1McpPostRequest: ...,
  } satisfies ApiV1McpPostOperationRequest;

  try {
    const data = await api.apiV1McpPost(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

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 "only these zones" 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.

Models

Authorization

Authentication schemes defined for the API:

apiKey

  • Type: HTTP Bearer Token authentication (gas_live_<32 chars>)

oauth2 accessCode

  • 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

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

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

The generated npm module supports the following:

  • Environments
    • Node.js
    • Webpack
    • Browserify
  • Language levels
    • ES5 - you must have a Promises/A+ library installed
    • ES6
  • Module systems
    • CommonJS
    • ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

About

Official JavaScript/TypeScript client for the GoAdserver REST API

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages