Adspert API
3.36.54
Quick Start
Public Routes
Authenticated Routes
Get Your API Key
Request an API Token
Get Some Data
Explore
Authentication and Authorization
Authentication Modes
api-key
api-token
Authorization
Access Level Elevation
Requests and Responses
URI Parameters
Query Parameters
Field Selection
Sorting
Filtering
Search
Response Enveloping
General
Successful Requests
Validation Errors
Other Errors
Media Types
CSV
Request Data
Response Data
Excel
Routes
Authentication
ApiTokenResource
POST
DELETE
ApiKeyCollection
GET
POST
PATCH
DELETE
TokenInvalidationAction
POST
Customers
CustomerCollection
GET
CustomerResource
GET
PATCH
CustomerAccessCollection
GET
POST
PUT
DELETE
CustomerTagCollection
GET
PUT
DELETE
Users
UserCollection
GET
UserResource
GET
PATCH
Accounts
AccountResource
GET
PATCH
AccountCollection
GET
PATCH
AccountTagCollection
GET
PUT
DELETE
BidAdjustmentSettingsCollection
GET
PATCH
Structure
PerformanceGroupCollection
GET
POST
PATCH
PerformanceGroupSuggestions
GET
POST
PerformanceGroupResource
GET
DELETE
PerformanceGroupSnapshotPerformanceCollection
GET
AmazonPortfolioResource
GET
AmazonPortfolioCollection
GET
CampaignResource
GET
CampaignCollection
GET
PATCH
AdgroupResource
GET
AdgroupCollection
GET
CriterionResource
GET
CriterionCollection
GET
ProductResource
GET
ProductCollection
GET
LabelCollection
GET
BudgetSuggestionCollection
GET
PATCH
Criterion Addition
RuleCollection
GET
PUT
DELETE
ProposalCollection
GET
PATCH
SettingsCollection
GET
PATCH
RuleTypeCollection
GET
DestinationAdGroupCollection
GET
DestinationTypeCollection
GET
Product Ad Sync
ProductAdSyncTargetsCollection
GET
PUT
DELETE
Performance
AccountPerformanceCollection
GET
CustomerPerformanceCollection
GET
POST
ProductPerformanceCollection
GET
ProductCampaignPerformanceCollection
GET
ProductAdGroupPerformanceCollection
GET
ProductConvertingCriteriaCollection
GET
ScenarioCollection
GET
POST
AdgroupInsightsResource
GET
CampaignInsightsResource
GET
Logs
PerformanceGroupLogCollection
GET
FilterUserCollectionPerformanceGroups
GET
PerformanceGroupLogEntryTypesCollection
GET
ProductAdSyncLogCollection
GET
AdGroupCreationLogCollection
GET
CampaignCreationLogCollection
GET
ProductAdSyncTargetsLogCollection
GET
FilterUserCollectionProductAdsSyncTargets
GET
ProposalsLogCollection
GET
FilterUserCollectionCriterionAdditionProposals
GET
ProposalDestinationStateCollection
GET
RulesLogCollection
GET
FilterUserCollectionCriterionAdditionRules
GET
OptSettingsLogCollection
GET
FilterUserCollectionOptSettingsLog
GET
BudgetSubmissionLogCollection
GET
FilterUserCollectionBudgetSuggestions
GET
Admin
UserAdminCollection
GET
Optimization Log & Stats
BiddingLogCollection
GET
BidAdjustmentLogCollection
GET
OptimizationStatsResource
GET
Miscellaneous
Retail Accounts
RetailAccountsCollection
GET
Currency Rates
CurrencyRateCollection
GET
API Status Check
StatusResource
GET
WorkerStatusResource
GET
Web hook endpoints for external services
StripeWebHookResource
POST
EbayWebHookAccountDelete
GET
POST
EbayWebHookBudgetStatus
GET
POST
MerchantSpringHookResource
POST
Data Formats
String Formats
Date
DateTime
Decimal
Email
LargeInteger
ResponseFieldReference
SearchableResponseFieldReference
Url
UUID
CompositeID
Integer Formats
Micros
SortDirective
Enums
AccountPerformanceGroupBy
AccountTagScope
Action
AdPlatform
AdgroupStatus
AmazonAccountType
AmzAdGroupType
AmzEndpoint
AmzTargetingType
ApiCurrency
ApiEnumBudgetSubmissionState
ApiEnumSyncMode
ApiOptSettingScopeEnum
AssignableUserRole
BidType
CampaignOptimizationSupport
CampaignStatus
CampaignType
ConversionValueSource
ConversionValueType
CriterionAdditionCriterionSubtype
CriterionAdditionCriterionType
CriterionAdditionDestinationLogState
CriterionAdditionDestinationState
CriterionAdditionDestinationType
CriterionAdditionDestinationWarningType
CriterionAdditionForcedReviewReason
CriterionAdditionMatchType
CriterionAdditionProposalReason
CriterionAdditionProposalState
CriterionAdditionProposalType
CriterionAdditionRuleAction
CriterionAdditionRuleCampaignType
CriterionAdditionRuleFilterOperand
CriterionAdditionRuleFilterOperation
CriterionAdditionRuleLevel
CriterionAdditionRuleLogAction
CriterionAdditionRuleLogReason
CriterionAdditionSettingLevel
CriterionAdditionSettingType
CriterionAdditionSettingValueType
CriterionMatchType
CriterionStatus
CriterionType
Currency
CustomerPerformanceGroupBy
CustomerTagScope
CustomerType
DimensionType
GroupBy
InvoiceLanguage
LabelLevel
OptSettingsType
OptimizationType
PerformanceGroupGoalType
PerformanceGroupLogEntryType
PerformanceGroupWarningPriority
PerformanceGroupWarningStatus
PerformanceGroupWarningType
PlatformAccessStatus
ProductAdSyncMode
ProductCriterionType
ProductEffectiveStatus
Reason
RetailAccessStatus
State
UserLanguage
UserRole
Release Notes
Deprecation Schedule
Preview Roadmap
Changelog
Version 3.13
Version 3.9
Version 3.8
Version 3.7
Version 3.6.1
Version 3.6
Version 3.5
Version 3.4
Glossary
Adspert API
Index
Index
A
|
B
|
C
|
E
|
I
|
K
|
M
|
O
|
P
|
R
|
W
A
ACKNOWLEDGED
Ad account
Ad platform
Adspert account ID
Advertising account
Advertising platform
AUDIENCE
B
BOOLEAN
C
CRR
E
ENUM
I
INTEGER
K
KEYWORD
M
MODE
O
OK
P
PAT
Performance group
PLACEMENT
R
ROAS
ROI
W
WEBPAGE