HTTP Routing Table

/v3
 
/v3
GET /v3/accounts None
GET /v3/accounts/(adspert_account_id:int) None
GET /v3/accounts/(adspert_account_id:int)/adgroups/bid-suggestions Get bid recommendations by task id.
GET /v3/accounts/(adspert_account_id:int)/bid-adjustment-settings None
GET /v3/accounts/(adspert_account_id:int)/criteria Retrieve a list of criteria.
GET /v3/accounts/(adspert_account_id:int)/criteria/(adspert_criterion_id:str) Retrieve a single criterion.
GET /v3/accounts/(adspert_account_id:int)/insights/adgroups/(adgroup_id:str) None
GET /v3/accounts/(adspert_account_id:int)/insights/campaigns/(campaign_id:str) None
GET /v3/accounts/(adspert_account_id:int)/log/bid-adjustments Retrieve bids adjusted by |Adspert|.
GET /v3/accounts/(adspert_account_id:int)/log/bidding Retrieve bids changed by |Adspert|.
GET /v3/accounts/(adspert_account_id:int)/log/platform-settings Retrieve platform settings adjusted by |Adspert|.
GET /v3/accounts/(adspert_account_id:int)/management/utils/amazon/brands Get brand targets by task id.
GET /v3/accounts/(adspert_account_id:int)/management/utils/amazon/category Get Category Tree
GET /v3/accounts/(adspert_account_id:int)/management/utils/amazon/category/refinements Get possible refinements for a category.
GET /v3/accounts/(adspert_account_id:int)/management/utils/amazon/category/refinements/count Get count of ASINs for a refined Category
GET /v3/accounts/(adspert_account_id:int)/management/utils/amazon/category/suggestions Get Category Suggestions
GET /v3/accounts/(adspert_account_id:int)/management/utils/amazon/keyword-groups Get keyword groups by task id.
GET /v3/accounts/(adspert_account_id:int)/management/utils/amazon/keywords Get keyword suggestions by task id.
GET /v3/accounts/(adspert_account_id:int)/management/utils/amazon/product/keywords Get product search results by task id.
GET /v3/accounts/(adspert_account_id:int)/management/utils/amazon/product/suggestions Get product suggestions by task id.
GET /v3/accounts/(adspert_account_id:int)/performance None
GET /v3/accounts/(adspert_account_id:int)/products Retrieve a list of products.
GET /v3/accounts/(adspert_account_id:int)/products/(adspert_product_id:b32) Retrieve a single product.
GET /v3/accounts/tags Retrieve a list of account tags.
GET /v3/agent/interactions None
GET /v3/agent/meta None
GET /v3/agent/sessions None
GET /v3/auth/keys Retrieve API keys for authenticated user.
GET /v3/constants Get general enums and constants used across the API.
GET /v3/currency-rates Retrieve a list of currency rates.
GET /v3/customers Retrieve a list of customers.
GET /v3/customers/(customer_id:int) Retrieve a single customer.
GET /v3/customers/(customer_id:int)/access Retrieve a list of users with access to the customer.
GET /v3/customers/(customer_id:int)/adgroups Retrieve a list of ad groups.
GET /v3/customers/(customer_id:int)/adgroups/(adspert_adgroup_id:str) Retrieve a single ad group.
GET /v3/customers/(customer_id:int)/budget-suggestions None
GET /v3/customers/(customer_id:int)/budget/log Get budget submission log for respective customer.
GET /v3/customers/(customer_id:int)/budget/log/users Get users that can be used as filters in the log endpoint.
GET /v3/customers/(customer_id:int)/campaigns Retrieve a list of campaigns.
GET /v3/customers/(customer_id:int)/campaigns/(adspert_campaign_id:str) Retrieve a single campaign.
GET /v3/customers/(customer_id:int)/campaigns/utils/amazon/bid_metrics Retrieve Amz Campaign Bid Metrics
GET /v3/customers/(customer_id:int)/criterion-addition/destination-adgroups Get adgroups, evaluated for usage as a rule / proposal destination
GET /v3/customers/(customer_id:int)/criterion-addition/destination-types Get rule / proposal destination types.
GET /v3/customers/(customer_id:int)/criterion-addition/log/proposals Get Proposal Logs for respective customer.
GET /v3/customers/(customer_id:int)/criterion-addition/log/proposals/state Get Proposal Destination States for respective customer.
GET /v3/customers/(customer_id:int)/criterion-addition/log/proposals/users Get users that can be used as filters in the log endpoint.
GET /v3/customers/(customer_id:int)/criterion-addition/log/rules Get Proposal Logs for respective customer.
GET /v3/customers/(customer_id:int)/criterion-addition/log/rules/users Get users that can be used as filters in the log endpoint.
GET /v3/customers/(customer_id:int)/criterion-addition/proposals None
GET /v3/customers/(customer_id:int)/criterion-addition/rule-types Get available Criterion Addition rule types.
GET /v3/customers/(customer_id:int)/criterion-addition/rules Get criterion addition rules.
GET /v3/customers/(customer_id:int)/criterion-addition/settings Retrieve Criterion Addition settings.
GET /v3/customers/(customer_id:int)/management/create/queue Retrieve list of campaigns to be created.
GET /v3/customers/(customer_id:int)/management/log None
GET /v3/customers/(customer_id:int)/management/log/users Get users that can be used as filters in the log endpoint.
GET /v3/customers/(customer_id:int)/management/utils/amazon/bid-metrics Retrieve Amz Campaign Bid Metrics
GET /v3/customers/(customer_id:int)/opt-settings/log Get Proposal Logs for respective customer.
GET /v3/customers/(customer_id:int)/opt-settings/log/users Get users that can be used as filters in the log endpoint.
GET /v3/customers/(customer_id:int)/performance None
GET /v3/customers/(customer_id:int)/performance-groups Retrieve a list of performance groups.
GET /v3/customers/(customer_id:int)/performance-groups-extended Retrieve a list of performance groups.
GET /v3/customers/(customer_id:int)/performance-groups-suggestions Gives out suggestions for a prospective performance group.
GET /v3/customers/(customer_id:int)/performance-groups/(performance_group_id:int) Retrieve a single performance group.
GET /v3/customers/(customer_id:int)/performance-groups/(performance_group_id:int)/snapshot-performance None
GET /v3/customers/(customer_id:int)/performance-groups/log Get Performance Group Logs for respective customer.
GET /v3/customers/(customer_id:int)/performance-groups/log/entry-types Get entry type that can be used as filters in the
GET /v3/customers/(customer_id:int)/performance-groups/log/users Get users that can be used as filters in the log endpoint.
GET /v3/customers/(customer_id:int)/portfolios Retrieve a list of portfolios.
GET /v3/customers/(customer_id:int)/portfolios/(adspert_portfolio_id:str) Retrieve a single portfolio.
GET /v3/customers/(customer_id:int)/product-ax/log/adgroup Get amz adgroup log for respective customer.
GET /v3/customers/(customer_id:int)/product-ax/log/campaign Get amz campaign log for respective customer.
GET /v3/customers/(customer_id:int)/product-ax/log/sync Get product ad sync log for respective customer.
GET /v3/customers/(customer_id:int)/product-ax/log/sync-targets Get product ad sync targets logs for respective customer.
GET /v3/customers/(customer_id:int)/product-ax/log/sync-targets/users Get users that can be used as filters in the log endpoint.
GET /v3/customers/(customer_id:int)/product-ax/sync-targets Get product ad sync targets.
GET /v3/customers/(customer_id:int)/retail-accounts None
GET /v3/customers/(customer_id:int)/scenarios None
GET /v3/customers/(customer_id:int)/third-party-accounts None
GET /v3/customers/tags Retrieve a list of customer tags.
GET /v3/hooks/ebay/budget-status-notifications None
GET /v3/hooks/ebay/delete-notifications None
GET /v3/preview/accounts/(adspert_account_id:int)/performance/products None
GET /v3/preview/accounts/(adspert_account_id:int)/performance/products/(adspert_product_id:b32)/adgroups None
GET /v3/preview/accounts/(adspert_account_id:int)/performance/products/(adspert_product_id:b32)/campaigns None
GET /v3/preview/accounts/(adspert_account_id:int)/products/(adspert_product_id:b32)/converting-criteria None
GET /v3/preview/customers/(customer_id:int)/labels Retrieve a list of labels.
GET /v3/preview/customers/(customer_id:int)/optimization-stats None
GET /v3/ras/retailers Get a list of all notification definitions.
GET /v3/status A simple status check to check API availability.
GET /v3/status/worker A simple status check to test API worker responsiveness.
GET /v3/users Retrieve a list of users.
GET /v3/users/(user_id:int) Retrieve a single user.
POST /v3/accounts/(adspert_account_id:int)/adgroups/bid-suggestions Get bid recommendations.
POST /v3/accounts/(adspert_account_id:int)/management/utils/amazon/brands Create Task to get Brand Targets
POST /v3/accounts/(adspert_account_id:int)/management/utils/amazon/category Create Task to get Category Tree
POST /v3/accounts/(adspert_account_id:int)/management/utils/amazon/category/refinements Create task to get possible refinements for a category.
POST /v3/accounts/(adspert_account_id:int)/management/utils/amazon/category/refinements/count Create task to get count of ASINs for a refined Category
POST /v3/accounts/(adspert_account_id:int)/management/utils/amazon/category/suggestions Create task to get Category Suggestions
POST /v3/accounts/(adspert_account_id:int)/management/utils/amazon/keyword-groups Create Task to get Keyword Groups
POST /v3/accounts/(adspert_account_id:int)/management/utils/amazon/keywords Create Task to get Keyword Suggestions
POST /v3/accounts/(adspert_account_id:int)/management/utils/amazon/product/keywords Create Task to get search results for Amazon catalog based on keyword
POST /v3/accounts/(adspert_account_id:int)/management/utils/amazon/product/suggestions Create Task to get Product Suggestions
POST /v3/agent/interactions None
POST /v3/agent/sessions None
POST /v3/auth/invalidate-tokens Invalidate API tokens (sessions) for the authenticated user.
POST /v3/auth/keys Create a new API key for the authenticated user.
POST /v3/auth/token Create a new API token (a.k.a. access token).
POST /v3/customers/(customer_id:int)/access Invite a new user to access the customer.
POST /v3/customers/(customer_id:int)/campaigns/list Retrieve a list of campaigns via POST request.
POST /v3/customers/(customer_id:int)/management/create/amazon/sp None
POST /v3/customers/(customer_id:int)/management/create/amazon/sp/adgroup Create new adgroups under an existing campaign.
POST /v3/customers/(customer_id:int)/management/create/amazon/sp/criterion Create new Criteria under an existing Amazon adgroup.
POST /v3/customers/(customer_id:int)/management/create/walmart/sp Create a new Walmart campaign with adgroups.
POST /v3/customers/(customer_id:int)/management/create/walmart/sp/adgroup Create new adgroups under an existing Walmart campaign.
POST /v3/customers/(customer_id:int)/management/create/walmart/sp/criterion Create new Criteria under an existing Walmart adgroup.
POST /v3/customers/(customer_id:int)/management/edit Add new items to platform management queue.
POST /v3/customers/(customer_id:int)/performance None
POST /v3/customers/(customer_id:int)/performance-groups Create a new performance group.
POST /v3/customers/(customer_id:int)/performance-groups-suggestions Gives out suggestions for a prospective performance group.
POST /v3/customers/(customer_id:int)/scenarios None
POST /v3/customers/(customer_id:int)/suggestions-feedback Create a new suggestions feedback record.
POST /v3/hooks/ebay/budget-status-notifications None
POST /v3/hooks/ebay/delete-notifications None
POST /v3/hooks/merchantspring None
POST /v3/hooks/sentry None
POST /v3/hooks/sentry-comments None
POST /v3/hooks/stripe None
PUT /v3/accounts/tags Set a list of account tags.
PUT /v3/customers/(customer_id:int)/access Set access to the customer for one or more users.
PUT /v3/customers/(customer_id:int)/criterion-addition/rules Update/create criterion addition rules.
PUT /v3/customers/(customer_id:int)/product-ax/sync-targets Update/create product ad sync targets.
PUT /v3/customers/tags Set a list of account tags.
DELETE /v3/accounts/tags Delete a list of account tags.
DELETE /v3/agent/sessions None
DELETE /v3/auth/keys Delete API keys for the authenticated user.
DELETE /v3/auth/token Delete the API token which is used to authenticate this request.
DELETE /v3/customers/(customer_id:int)/access Remove access to the customer for one or more users.
DELETE /v3/customers/(customer_id:int)/criterion-addition/rules Delete criterion addition rules.
DELETE /v3/customers/(customer_id:int)/management/create/queue Bulk delete campaigns and adgroups in creation queue
DELETE /v3/customers/(customer_id:int)/management/edit Bulk delete items in platform management queue.
DELETE /v3/customers/(customer_id:int)/merchantspring Flags a MerchantSpring Account for archival
DELETE /v3/customers/(customer_id:int)/performance-groups/(performance_group_id:int) Delete a performance group.
DELETE /v3/customers/(customer_id:int)/product-ax/sync-targets None
DELETE /v3/customers/tags Delete a list of account tags.
PATCH /v3/accounts None
PATCH /v3/accounts/(adspert_account_id:int) None
PATCH /v3/accounts/(adspert_account_id:int)/bid-adjustment-settings None
PATCH /v3/agent/interactions Cancel interactions by setting status to CANCELED.
PATCH /v3/auth/keys Update the authenticated user's API keys.
PATCH /v3/customers/(customer_id:int) Update a single customer.
PATCH /v3/customers/(customer_id:int)/budget-suggestions None
PATCH /v3/customers/(customer_id:int)/campaigns Update a collection of campaigns.
PATCH /v3/customers/(customer_id:int)/criterion-addition/proposals Update criterion addition proposals.
PATCH /v3/customers/(customer_id:int)/criterion-addition/settings Update Criterion Addition settings.
PATCH /v3/customers/(customer_id:int)/management/create/amazon/sp/(campaign_mutate_id:int) Update an existing campaign in the queue.
PATCH /v3/customers/(customer_id:int)/management/create/amazon/sp/adgroup Update adgroups for an existing campaign.
PATCH /v3/customers/(customer_id:int)/management/create/amazon/sp/criterion Update criteria for an existing Amazon adgroup.
PATCH /v3/customers/(customer_id:int)/management/create/walmart/sp/(campaign_mutate_id:int) Update an existing Walmart campaign in the queue.
PATCH /v3/customers/(customer_id:int)/management/create/walmart/sp/adgroup Update adgroups for an existing Walmart campaign.
PATCH /v3/customers/(customer_id:int)/management/create/walmart/sp/criterion Update criteria for an existing Walmart adgroup.
PATCH /v3/customers/(customer_id:int)/merchantspring Removes a MerchantSpring Account's flag for archival
PATCH /v3/customers/(customer_id:int)/performance-groups Update a collection of performance groups.
PATCH /v3/users/(user_id:int) Update a user.