Adspert API
3.39.40
  • 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
      • AmzSponsoredProductsCampaignCreateCollection
        • GET
        • POST
        • DELETE
      • AmzSponsoredProductsCampaignCreateResource
        • PATCH
      • AmzBidMetricsCollection
        • GET
      • AdgroupResource
        • GET
      • AdgroupCollection
        • GET
      • AdgroupBidSuggestionResource
        • GET
        • POST
      • 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
      • AmzSponsoredProductsCampaignCreateLogCollection
        • GET
      • FilterUserCollectionAmzCampaignCreationLog
        • 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
    • Optimization Log & Stats
      • BiddingLogCollection
        • GET
      • BidAdjustmentLogCollection
        • GET
      • PlatformSettingLogCollection
        • GET
      • OptimizationStatsResource
        • GET
    • Miscellaneous
      • Retail Accounts
        • RetailAccountsCollection
          • GET
      • Third Party Accounts
        • ThirdPartyAccountsCollection
          • GET
        • MerchantSpring
          • MerchantSpringResource
            • PATCH
            • DELETE
      • Currency Rates
        • CurrencyRateCollection
          • GET
      • API Status Check
        • StatusResource
          • GET
        • WorkerStatusResource
          • GET
      • Constants and Enums
        • ConstantsResource
          • GET
    • Web hook endpoints for external services
      • StripeWebHookResource
        • POST
      • EbayWebHookAccountDelete
        • GET
        • POST
      • EbayWebHookBudgetStatus
        • GET
        • POST
      • MerchantSpringHookResource
        • POST
      • SentryErrorsWebHookResource
        • POST
      • SentryCommentsWebHookResource
        • 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
      • AdspertPlanType
      • AmazonAccountType
      • AmzAdGroupType
      • AmzCampaignType
      • AmzCostType
      • AmzEndpoint
      • AmzTargetingType
      • ApiAmzCreativeType
      • ApiAmzSponsoredProductsBiddingStrategyEnum
      • ApiCurrency
      • ApiEnumBudgetSubmissionState
      • ApiEnumSyncMode
      • ApiEnumThirdPartyAccessStatus
      • ApiEnumThirdPartyPlatform
      • ApiOptSettingScopeEnum
      • AssignableUserRole
      • BidType
      • BiddingStrategy
      • 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
      • CustomerSegment
      • CustomerTagScope
      • CustomerType
      • DimensionType
      • GroupBy
      • InvoiceCurrency
      • InvoiceLanguage
      • LabelLevel
      • OptSettingsType
      • OptimizationType
      • PerformanceGroupGoalType
      • PerformanceGroupLogEntryType
      • PerformanceGroupWarningPriority
      • PerformanceGroupWarningStatus
      • PerformanceGroupWarningType
      • PlatformAccessStatus
      • PlatformSettingType
      • ProductAdSyncMode
      • ProductCriterionType
      • ProductEffectiveStatus
      • Reason
      • RetailAccessStatus
      • SPTargetingExpressions
      • State
      • SubscriptionStatus
      • TargetExpression
      • TaskStatus
      • 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
  • Search