Routes

This page provides detailed descriptions for available API routes. See also the index for a compact view.

Authentication

Routes to manage (programmatic) API keys and tokens

ApiTokenResource

POST

POST /v3/auth/token

Create a new API token (a.k.a. access token).

Auth mode:

api-key

Access level:

user

Response Data (single object, json or csv or xlsx)

Name	Type	Description
token	String	Session token to be used as bearer token for API interaction.

Example

http

POST /v3/auth/token HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Basic U2FNcExFMEtlWTpzQW1QbGUwU2VDckV0NDMyMQ==

curl

curl -i -X POST https://api.adspert.net/v3/auth/token -H "Accept: application/json" --user SaMpLE0KeY:sAmPle0SeCrEt4321

httpie

http POST https://api.adspert.net/v3/auth/token Accept:application/json -a SaMpLE0KeY:sAmPle0SeCrEt4321

python-requests

requests.post('https://api.adspert.net/v3/auth/token', headers={'Accept': 'application/json'}, auth=('SaMpLE0KeY', 'sAmPle0SeCrEt4321'))

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "token": "pariatur sit"
  },
  "meta": {}
}

DELETE

DELETE /v3/auth/token

Delete the API token which is used to authenticate this request.

Auth mode:

api-token

Access level:

user

Example

http

DELETE /v3/auth/token HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X DELETE https://api.adspert.net/v3/auth/token -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http DELETE https://api.adspert.net/v3/auth/token Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.delete('https://api.adspert.net/v3/auth/token', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

ApiKeyCollection

GET

GET /v3/auth/keys

Retrieve API keys for authenticated user.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_active	[ Boolean ]	Only return results matching given active values.
filter_created_at_ge	Date	Only return results where created_at is on or after this date.
filter_created_at_le	Date	Only return results where created_at is on or before this date.
filter_last_used_at_ge	Date	Only return results where last_used_at is on or after this date.
filter_last_used_at_le	Date	Only return results where last_used_at is on or before this date.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_key_id	String	Only return results where key_id matches the given string.
search_name	String	Only return results where name matches the given string.
sort_active	SortDirective	Sort results by active.
sort_created_at	SortDirective	Sort results by created_at.
sort_key_id	SortDirective	Sort results by key_id.
sort_last_used_at	SortDirective	Sort results by last_used_at.
sort_name	SortDirective	Sort results by name.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
name searchable	String
key_id searchable	String
active	Boolean
created_at	DateTime
last_used_at	DateTime

Example

http

GET /v3/auth/keys?filter_last_used_at_ge=2018-10-21&sort_last_used_at=9&offset=0 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/auth/keys?filter_last_used_at_ge=2018-10-21&sort_last_used_at=9&offset=0' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/auth/keys?filter_last_used_at_ge=2018-10-21&sort_last_used_at=9&offset=0' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/auth/keys?filter_last_used_at_ge=2018-10-21&sort_last_used_at=9&offset=0', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "name": "tucan lorem",
      "key_id": "vehicula lorem",
      "active": true,
      "created_at": "2018-10-21T16:45:23+02:00",
      "last_used_at": "2018-10-21T16:45:23+02:00"
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "name": 1
      }
    }
  }
}

POST

POST /v3/auth/keys

Create a new API key for the authenticated user.

The response is the only time that the API reveals the key’s secret!

Responds with a 409 if a key with a similar name already exists.

Auth mode:

api-token

Access level:

user

Request Data (single object, json or csv)

Name	Type	Description
name required	String

Response Data (single object, json or csv or xlsx)

Name	Type	Description
name	String
key_id	String
active	Boolean
secret	String
created_at	DateTime
last_used_at	DateTime

Example

http

POST /v3/auth/keys HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

{
  "name": "tucan lorem"
}

curl

curl -i -X POST https://api.adspert.net/v3/auth/keys -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '{"name": "tucan lorem"}'

httpie

echo '{
  "name": "tucan lorem"
}' | http POST https://api.adspert.net/v3/auth/keys Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.post('https://api.adspert.net/v3/auth/keys', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json={'name': 'tucan lorem'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "name": "tucan lorem",
    "key_id": "vehicula lorem",
    "active": true,
    "secret": "lorem dolor",
    "created_at": "2018-10-21T16:45:23+02:00",
    "last_used_at": "2018-10-21T16:45:23+02:00"
  },
  "meta": {}
}

PATCH

PATCH /v3/auth/keys

Update the authenticated user’s API keys.

Responds with a 409 if a key name change would result in multiple keys with the same name.

Auth mode:

api-token

Access level:

user

Request Data (object list, json or csv)

Name	Type	Description
name	String
key_id required	String
active	Boolean

Response Data (single object, json or csv or xlsx)

Name	Type	Description
unchanged	[ Object ]	List of objects which had no effective change.
⤷ name	String	See request data description.
⤷ key_id	String	See request data description.
⤷ active	Boolean	See request data description.
unknown	[ Object ]	List of objects which could not be found.
⤷ name	String	See request data description.
⤷ key_id	String	See request data description.
⤷ active	Boolean	See request data description.
updated	[ Object ]	List of objects which have been updated.
⤷ name	String	See request data description.
⤷ key_id	String	See request data description.
⤷ active	Boolean	See request data description.

Example

http

PATCH /v3/auth/keys HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "name": "tucan lorem",
    "key_id": "vehicula lorem",
    "active": true
  }
]

curl

curl -i -X PATCH https://api.adspert.net/v3/auth/keys -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"name": "tucan lorem", "key_id": "vehicula lorem", "active": true}]'

httpie

echo '[
  {
    "active": true,
    "key_id": "vehicula lorem",
    "name": "tucan lorem"
  }
]' | http PATCH https://api.adspert.net/v3/auth/keys Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.patch('https://api.adspert.net/v3/auth/keys', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'name': 'tucan lorem', 'key_id': 'vehicula lorem', 'active': True}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "unchanged": [
      {
        "name": "tucan lorem",
        "key_id": "vehicula lorem",
        "active": true
      }
    ],
    "unknown": [
      {
        "name": "tucan lorem",
        "key_id": "vehicula lorem",
        "active": true
      }
    ],
    "updated": [
      {
        "name": "tucan lorem",
        "key_id": "vehicula lorem",
        "active": true
      }
    ]
  },
  "meta": {}
}

DELETE

DELETE /v3/auth/keys

Delete API keys for the authenticated user.

Auth mode:

api-token

Access level:

user

Request Data (object list, json or csv)

Name	Type	Description
key_id required	String

Response Data (single object, json or csv or xlsx)

Name	Type	Description
deleted	[ Object ]	List of objects which have been deleted.
⤷ name	String	See request data description.
⤷ key_id	String	See request data description.
⤷ active	Boolean	See request data description.
unknown	[ Object ]	List of objects which could not be found.
⤷ name	String	See request data description.
⤷ key_id	String	See request data description.
⤷ active	Boolean	See request data description.

Example

http

DELETE /v3/auth/keys HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "key_id": "vehicula lorem"
  }
]

curl

curl -i -X DELETE https://api.adspert.net/v3/auth/keys -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"key_id": "vehicula lorem"}]'

httpie

echo '[
  {
    "key_id": "vehicula lorem"
  }
]' | http DELETE https://api.adspert.net/v3/auth/keys Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.delete('https://api.adspert.net/v3/auth/keys', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'key_id': 'vehicula lorem'}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "deleted": [
      {
        "name": "tucan lorem",
        "key_id": "vehicula lorem",
        "active": true
      }
    ],
    "unknown": [
      {
        "name": "tucan lorem",
        "key_id": "vehicula lorem",
        "active": true
      }
    ]
  },
  "meta": {}
}

TokenInvalidationAction

POST

POST /v3/auth/invalidate-tokens

Invalidate API tokens (sessions) for the authenticated user.

This includes one-time tokens like used for password reset mails.

The token used to authenticate the current request is preserved!

Auth mode:

api-token

Access level:

user

Example

http

POST /v3/auth/invalidate-tokens HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X POST https://api.adspert.net/v3/auth/invalidate-tokens -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http POST https://api.adspert.net/v3/auth/invalidate-tokens Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.post('https://api.adspert.net/v3/auth/invalidate-tokens', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

Customers

CustomerCollection

GET

GET /v3/customers

Retrieve a list of customers.

Auth mode:

api-token

Access level:

user – some fields require access level elevation to customer-admin

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_access	[ UserRole ]	Only return results matching given access values.
filter_account_move_in_progress	[ Boolean ]	Only return results matching given account_move_in_progress values.
filter_allow_self_service_checkout	[ Boolean ]	Only return results matching given allow_self_service_checkout values.
filter_allow_start_optimization	[ Boolean ]	Only return results matching given allow_start_optimization values.
filter_archived	[ Boolean ]	Only return results matching given archived values.
filter_canceled	[ Boolean ]	Only return results matching given canceled values.
filter_canceled_due_ge	Date	Only return results where canceled_due is on or after this date.
filter_canceled_due_le	Date	Only return results where canceled_due is on or before this date.
filter_country_code	[ String ]	Only return results matching given country_code values. Min access level: customer-admin
filter_created_at_ge	Date	Only return results where created_at is on or after this date.
filter_created_at_le	Date	Only return results where created_at is on or before this date.
filter_customer_id	[ Integer ]	Only return results matching given customer_id values.
filter_is_demo	[ Boolean ]	Only return results matching given is_demo values.
filter_main_customer_id	[ Integer ]	Only return results matching given main_customer_id values.
filter_notifications	[ Boolean ]	Only return results matching given notifications values.
filter_trial	[ Boolean ]	Only return results matching given trial values.
filter_trial_end_ge	Date	Only return results where trial_end is on or after this date.
filter_trial_end_le	Date	Only return results where trial_end is on or before this date.
filter_trial_start_ge	Date	Only return results where trial_start is on or after this date.
filter_trial_start_le	Date	Only return results where trial_start is on or before this date.
filter_type	[ CustomerType ]	Only return results matching given type values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_customer_id	String	Only return results where customer_id matches the given string.
search_email	String	Only return results where email matches the given string. Min access level: customer-admin
search_main_customer_id	String	Only return results where main_customer_id matches the given string.
search_main_customer_name	String	Only return results where main_customer_name matches the given string. Min access level: customer-admin
search_name	String	Only return results where name matches the given string.
sort_access	SortDirective	Sort results by access.
sort_agency_admins_count	SortDirective	Sort results by agency_admins_count. Min access level: customer-admin
sort_agency_clients_count	SortDirective	Sort results by agency_clients_count. Min access level: customer-admin
sort_billing_subsidiaries_count	SortDirective	Sort results by billing_subsidiaries_count. Min access level: customer-admin
sort_canceled	SortDirective	Sort results by canceled.
sort_canceled_due	SortDirective	Sort results by canceled_due.
sort_country_code	SortDirective	Sort results by country_code. Min access level: customer-admin
sort_created_at	SortDirective	Sort results by created_at.
sort_customer_id	SortDirective	Sort results by customer_id.
sort_email	SortDirective	Sort results by email. Min access level: customer-admin
sort_main_customer_id	SortDirective	Sort results by main_customer_id.
sort_main_customer_name	SortDirective	Sort results by main_customer_name. Min access level: customer-admin
sort_name	SortDirective	Sort results by name.
sort_notifications	SortDirective	Sort results by notifications.
sort_trial	SortDirective	Sort results by trial.
sort_trial_end	SortDirective	Sort results by trial_end.
sort_trial_start	SortDirective	Sort results by trial_start.
sort_type	SortDirective	Sort results by type.
sort_unread_notifications_count	SortDirective	Sort results by unread_notifications_count.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
customer_id searchable	Integer
type	CustomerType
main_customer_id searchable	Integer	If the customer type is not MAIN, then this refers to the corresponding main customer.
main_customer_name searchable	String	If the customer type is not MAIN, then this refers to the corresponding main customer. Min access level: customer-admin
billing_subsidiaries_count	Integer	Number of billing subsidiary sub customers. Min access level: customer-admin
agency_clients_count	Integer	Number of agency client sub customers. Min access level: customer-admin
agency_admins_count	Integer	Number of users with agency admin access on the customer. Min access level: customer-admin
account_move_in_progress	Boolean	If accounts of this customer are currently moved to another customer.
name searchable	String	Name of the customer’s business (billing addressee).
email searchable	Email	Primary e-mail contact for billing purposes. Min access level: customer-admin
address_1	String	Billing address: line 1. Min access level: customer-admin
address_2	String	Billing address: line 2. Min access level: customer-admin
zip	String	Billing address: postal code. Min access level: customer-admin
city	String	Billing address: city. Min access level: customer-admin
country_code	String	Billing address: two letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Min access level: customer-admin
invoice_language	InvoiceLanguage	Min access level: customer-admin
invoice_currency	InvoiceCurrency	Currency used for upcoming invoices. DEPRECATED: Use metric_currency or subscription_currency or checkout_currency instead.
order_number	String	Order number chosen by customer to appear on invoices. Min access level: customer-admin
vat_id	String	VAT-ID of the customer’s business. Min access level: customer-admin
vat_id_valid	Boolean	VAT-ID validation status. null means the ID is not yet validated. Validation happens asynchronously, this is why no prompt feedback during a PATCH request can be given. Min access level: customer-admin
allow_self_service_checkout	Boolean	If the customer can start a subscription in self-service or not. If disabled, subscriptions are managed by the CSM team.
trial_start	Date	Start date for the period where the customer is optimized but not charged. NOTE: Creating a subscription automatically adjusts trial periods if trial and subscription periods overlap. The subscription is the authority here.
trial_end	Date	Last day of the period where the customer is optimized but not charged. What happens after that date depends: After that date, optimization will be disabled, until a subscription starts. So if there is a subscription starting the next day, there will be no gap in optimization. NOTE: Creating a subscription automatically adjusts trial periods if trial and subscription periods overlap. The subscription is the authority here.
trial	Boolean	If the customer is currently within a trial.
canceled_due	Date	Customer cancelation date (equals end date of the customer’s subscription, if there is one). Once passed, the customer is in a canceled state. When setting this field, the earliest allowed date is “yesterday” or the customer’s trial end date (if set), whatever is more recent. Agency admin customers can only set this on sub-customers of the agency’s main Adspert customer. This field is not editable if a customer has a subscription! In that case the subscription’s end date dictates cancelation. Use /v3/customer/.../subscription to control cancelation.
canceled	Boolean	If the customer is in a canceled state (canceled_due is set and in the past, or the customer is archived).
allow_start_optimization	Boolean	If optimization of ad accounts for this customer may be started.
metric_currency	ApiCurrency	Default currency for displaying cross-account performance metrics (when no user-specific currency setting exists).
archived	Boolean	Flag indicating if this customer is in archived state. An archived customer cannot be modified.
created_at	Date	Date of the customer creation.
is_demo	Boolean	Is this a demo customer?
access	UserRole	The authenticated user’s effective role in context of the customer.
notifications	Boolean	If the authenticated user can see notifications for this customer.
unread_notifications_count	Integer	Number of unread notifications on the customer for the authenticated user.

Example

http

GET /v3/customers?sort_trial_start=-8&search_main_customer_id=sit+ipsum&sort_trial_end=7 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...
X-Adspert-Access-Level: CUSTOMER-ADMIN

curl

curl -i -X GET 'https://api.adspert.net/v3/customers?sort_trial_start=-8&search_main_customer_id=sit+ipsum&sort_trial_end=7' -H "Accept: application/json" -H "X-Adspert-Access-Level: CUSTOMER-ADMIN" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers?sort_trial_start=-8&search_main_customer_id=sit+ipsum&sort_trial_end=7' Accept:application/json X-Adspert-Access-Level:"CUSTOMER-ADMIN" Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers?sort_trial_start=-8&search_main_customer_id=sit+ipsum&sort_trial_end=7', headers={'Accept': 'application/json', 'X-Adspert-Access-Level': 'CUSTOMER-ADMIN', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "customer_id": 2022024680,
      "type": "AGENCY-CLIENT",
      "main_customer_id": 2022024680,
      "main_customer_name": "adlora tucan",
      "billing_subsidiaries_count": 9885699150,
      "agency_clients_count": 1485799544,
      "agency_admins_count": 1478096067,
      "account_move_in_progress": true,
      "name": "tucan lorem",
      "email": "ipsum@example.com",
      "address_1": "adlora dolor",
      "address_2": "tucan adlora",
      "zip": "vehicula ipsum",
      "city": "vehicula amet",
      "country_code": "nl",
      "invoice_language": "DE",
      "invoice_currency": "EUR",
      "order_number": "amet sit",
      "vat_id": "amet elit",
      "vat_id_valid": true,
      "allow_self_service_checkout": true,
      "trial_start": "2018-10-21",
      "trial_end": "2018-10-21",
      "trial": true,
      "canceled_due": "2018-10-21",
      "canceled": true,
      "allow_start_optimization": true,
      "metric_currency": "AED",
      "archived": true,
      "created_at": "2018-10-21",
      "is_demo": true,
      "access": "AGENCY-ADMIN",
      "notifications": true,
      "unread_notifications_count": 1380600209
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "customer_id": 1
      }
    }
  }
}

CustomerResource

GET

GET /v3/customers/(customer_id: int)

Retrieve a single customer.

Auth mode:

api-token

Access level:

user – some fields require access level elevation to customer-admin

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
customer_id	Integer
type	CustomerType
main_customer_id	Integer	If the customer type is not MAIN, then this refers to the corresponding main customer.
main_customer_name	String	If the customer type is not MAIN, then this refers to the corresponding main customer. Min access level: customer-admin
billing_subsidiaries_count	Integer	Number of billing subsidiary sub customers. Min access level: customer-admin
agency_clients_count	Integer	Number of agency client sub customers. Min access level: customer-admin
agency_admins_count	Integer	Number of users with agency admin access on the customer. Min access level: customer-admin
account_move_in_progress	Boolean	If accounts of this customer are currently moved to another customer.
name	String	Name of the customer’s business (billing addressee).
email	Email	Primary e-mail contact for billing purposes. Min access level: customer-admin
address_1	String	Billing address: line 1. Min access level: customer-admin
address_2	String	Billing address: line 2. Min access level: customer-admin
zip	String	Billing address: postal code. Min access level: customer-admin
city	String	Billing address: city. Min access level: customer-admin
country_code	String	Billing address: two letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Min access level: customer-admin
invoice_language	InvoiceLanguage	Min access level: customer-admin
invoice_currency	InvoiceCurrency	Currency used for upcoming invoices. DEPRECATED: Use metric_currency or subscription_currency or checkout_currency instead.
order_number	String	Order number chosen by customer to appear on invoices. Min access level: customer-admin
vat_id	String	VAT-ID of the customer’s business. Min access level: customer-admin
vat_id_valid	Boolean	VAT-ID validation status. null means the ID is not yet validated. Validation happens asynchronously, this is why no prompt feedback during a PATCH request can be given. Min access level: customer-admin
allow_self_service_checkout	Boolean	If the customer can start a subscription in self-service or not. If disabled, subscriptions are managed by the CSM team.
trial_start	Date	Start date for the period where the customer is optimized but not charged. NOTE: Creating a subscription automatically adjusts trial periods if trial and subscription periods overlap. The subscription is the authority here.
trial_end	Date	Last day of the period where the customer is optimized but not charged. What happens after that date depends: After that date, optimization will be disabled, until a subscription starts. So if there is a subscription starting the next day, there will be no gap in optimization. NOTE: Creating a subscription automatically adjusts trial periods if trial and subscription periods overlap. The subscription is the authority here.
trial	Boolean	If the customer is currently within a trial.
canceled_due	Date	Customer cancelation date (equals end date of the customer’s subscription, if there is one). Once passed, the customer is in a canceled state. When setting this field, the earliest allowed date is “yesterday” or the customer’s trial end date (if set), whatever is more recent. Agency admin customers can only set this on sub-customers of the agency’s main Adspert customer. This field is not editable if a customer has a subscription! In that case the subscription’s end date dictates cancelation. Use /v3/customer/.../subscription to control cancelation.
canceled	Boolean	If the customer is in a canceled state (canceled_due is set and in the past, or the customer is archived).
allow_start_optimization	Boolean	If optimization of ad accounts for this customer may be started.
metric_currency	ApiCurrency	Default currency for displaying cross-account performance metrics (when no user-specific currency setting exists).
archived	Boolean	Flag indicating if this customer is in archived state. An archived customer cannot be modified.
created_at	Date	Date of the customer creation.
features	[ String ]	Features enabled for the customer.
is_demo	Boolean	Is this a demo customer?
access	UserRole	The authenticated user’s effective role in context of the customer.
notifications	Boolean	If the authenticated user can see notifications for this customer.
unread_notifications_count	Integer	Number of unread notifications on the customer for the authenticated user.

Example

http

GET /v3/customers/7027038674?include=ipsum.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...
X-Adspert-Access-Level: CUSTOMER-ADMIN

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674?include=ipsum.amet' -H "Accept: application/json" -H "X-Adspert-Access-Level: CUSTOMER-ADMIN" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674?include=ipsum.amet' Accept:application/json X-Adspert-Access-Level:"CUSTOMER-ADMIN" Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674?include=ipsum.amet', headers={'Accept': 'application/json', 'X-Adspert-Access-Level': 'CUSTOMER-ADMIN', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "customer_id": 2022024680,
    "type": "AGENCY-CLIENT",
    "main_customer_id": 2022024680,
    "main_customer_name": "adlora tucan",
    "billing_subsidiaries_count": 9885699150,
    "agency_clients_count": 1485799544,
    "agency_admins_count": 1478096067,
    "account_move_in_progress": true,
    "name": "tucan lorem",
    "email": "ipsum@example.com",
    "address_1": "adlora dolor",
    "address_2": "tucan adlora",
    "zip": "vehicula ipsum",
    "city": "vehicula amet",
    "country_code": "nl",
    "invoice_language": "DE",
    "invoice_currency": "EUR",
    "order_number": "amet sit",
    "vat_id": "amet elit",
    "vat_id_valid": true,
    "allow_self_service_checkout": true,
    "trial_start": "2018-10-21",
    "trial_end": "2018-10-21",
    "trial": true,
    "canceled_due": "2018-10-21",
    "canceled": true,
    "allow_start_optimization": true,
    "metric_currency": "AED",
    "archived": true,
    "created_at": "2018-10-21",
    "features": [
      "sit elit"
    ],
    "is_demo": true,
    "access": "AGENCY-ADMIN",
    "notifications": true,
    "unread_notifications_count": 1380600209
  },
  "meta": {}
}

PATCH

PATCH /v3/customers/(customer_id: int)

Update a single customer.

If the customer is a sub customer (billing subsidiary or agency client) and its main customer is in a canceled state, any changes that would revive the sub customer are rejected with a 409 Conflict. To resolve this, the main customer needs to be revived first.

Auth mode:

api-token

Access level:

customer-admin

Request Data (single object, json or csv)

Name	Type	Description
name	String	Name of the customer’s business (billing addressee). Min length: 1
email	Email	Primary e-mail contact for billing purposes. Min length: 1
address_1	String	Billing address: line 1. Min length: 1
address_2	String	Billing address: line 2.
zip	String	Billing address: postal code. Min length: 1
city	String	Billing address: city. Min length: 1
country_code	String	Billing address: two letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Min length: 2 Max length: 2
invoice_language	InvoiceLanguage
invoice_currency	InvoiceCurrency	Currency used for upcoming invoices. DEPRECATED: Use metric_currency or subscription_currency or checkout_currency instead.
order_number	String	Order number chosen by customer to appear on invoices.
vat_id	String	VAT-ID of the customer’s business.
metric_currency	ApiCurrency	Default currency for displaying cross-account performance metrics (when no user-specific currency setting exists).

Example

http

PATCH /v3/customers/7027038674 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

{
  "name": "tucan lorem",
  "email": "ipsum@example.com",
  "address_1": "adlora dolor",
  "address_2": "tucan adlora",
  "zip": "vehicula ipsum",
  "city": "vehicula amet",
  "country_code": "nl",
  "invoice_language": "DE",
  "invoice_currency": "EUR",
  "order_number": "amet sit",
  "vat_id": "amet elit",
  "metric_currency": "AED"
}

curl

curl -i -X PATCH https://api.adspert.net/v3/customers/7027038674 -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '{"address_1": "adlora dolor", "address_2": "tucan adlora", "city": "vehicula amet", "country_code": "nl", "email": "ipsum@example.com", "invoice_currency": "EUR", "invoice_language": "DE", "metric_currency": "AED", "name": "tucan lorem", "order_number": "amet sit", "vat_id": "amet elit", "zip": "vehicula ipsum"}'

httpie

echo '{
  "address_1": "adlora dolor",
  "address_2": "tucan adlora",
  "city": "vehicula amet",
  "country_code": "nl",
  "email": "ipsum@example.com",
  "invoice_currency": "EUR",
  "invoice_language": "DE",
  "metric_currency": "AED",
  "name": "tucan lorem",
  "order_number": "amet sit",
  "vat_id": "amet elit",
  "zip": "vehicula ipsum"
}' | http PATCH https://api.adspert.net/v3/customers/7027038674 Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.patch('https://api.adspert.net/v3/customers/7027038674', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json={'address_1': 'adlora dolor', 'address_2': 'tucan adlora', 'city': 'vehicula amet', 'country_code': 'nl', 'email': 'ipsum@example.com', 'invoice_currency': 'EUR', 'invoice_language': 'DE', 'metric_currency': 'AED', 'name': 'tucan lorem', 'order_number': 'amet sit', 'vat_id': 'amet elit', 'zip': 'vehicula ipsum'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

CustomerAccessCollection

GET

GET /v3/customers/(customer_id: int)/access

Retrieve a list of users with access to the customer.

This only covers explicit access permissions (not implicit ones like agency admin access to sub-customers).

Auth mode:

api-token

Access level:

customer-admin

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_lang	[ UserLanguage ]	Only return results matching given lang values.
filter_notifications	[ Boolean ]	Only return results matching given notifications values.
filter_role	[ AssignableUserRole ]	Only return results matching given role values.
filter_user_id	[ Integer ]	Only return results matching given user_id values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_email	String	Only return results where email matches the given string.
search_first_name	String	Only return results where first_name matches the given string.
search_last_name	String	Only return results where last_name matches the given string.
search_user_id	String	Only return results where user_id matches the given string.
sort_email	SortDirective	Sort results by email.
sort_first_name	SortDirective	Sort results by first_name.
sort_lang	SortDirective	Sort results by lang.
sort_last_name	SortDirective	Sort results by last_name.
sort_notifications	SortDirective	Sort results by notifications.
sort_role	SortDirective	Sort results by role.
sort_user_id	SortDirective	Sort results by user_id.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
user_id searchable	Integer
email searchable	Email
first_name searchable	String
last_name searchable	String
lang	UserLanguage	A user’s preferred language.
role	AssignableUserRole	The role assigned to a user on a customer.
notifications	Boolean	If the user is allowed to see notifications for this customer.

Example

http

GET /v3/customers/7027038674/access?search_term=vehicula+ipsum&search_user_id=lorem+vehicula&filter_notifications=True HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/access?search_term=vehicula+ipsum&search_user_id=lorem+vehicula&filter_notifications=True' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/access?search_term=vehicula+ipsum&search_user_id=lorem+vehicula&filter_notifications=True' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/access?search_term=vehicula+ipsum&search_user_id=lorem+vehicula&filter_notifications=True', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "user_id": 4034300999,
      "email": "ipsum@example.com",
      "first_name": "pariatur ipsum",
      "last_name": "adlora amet",
      "lang": "DE",
      "role": "AGENCY-ADMIN",
      "notifications": true
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "user_id": 1
      }
    }
  }
}

POST

POST /v3/customers/(customer_id: int)/access

Invite a new user to access the customer.

Potentially creates a new Adspert user if there is none for the given email address.

The added user receives an invitation email.

Auth mode:

api-token

Access level:

customer-admin

Request Data (single object, json or csv)

Name	Type	Description
email required	Email
first_name	String
last_name	String
lang	UserLanguage	A user’s preferred language. Default: EN
role required	AssignableUserRole	The role assigned to a user on a customer.
notifications required	Boolean	If the user is allowed to see notifications for this customer.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
user_id	Integer
email	Email
first_name	String
last_name	String
lang	UserLanguage	A user’s preferred language.
role	AssignableUserRole	The role assigned to a user on a customer.
notifications	Boolean	If the user is allowed to see notifications for this customer.

Example

http

POST /v3/customers/7027038674/access HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

{
  "email": "ipsum@example.com",
  "first_name": "pariatur ipsum",
  "last_name": "adlora amet",
  "lang": "DE",
  "role": "AGENCY-ADMIN",
  "notifications": true
}

curl

curl -i -X POST https://api.adspert.net/v3/customers/7027038674/access -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '{"email": "ipsum@example.com", "first_name": "pariatur ipsum", "lang": "DE", "last_name": "adlora amet", "notifications": true, "role": "AGENCY-ADMIN"}'

httpie

echo '{
  "email": "ipsum@example.com",
  "first_name": "pariatur ipsum",
  "lang": "DE",
  "last_name": "adlora amet",
  "notifications": true,
  "role": "AGENCY-ADMIN"
}' | http POST https://api.adspert.net/v3/customers/7027038674/access Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.post('https://api.adspert.net/v3/customers/7027038674/access', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json={'email': 'ipsum@example.com', 'first_name': 'pariatur ipsum', 'lang': 'DE', 'last_name': 'adlora amet', 'notifications': True, 'role': 'AGENCY-ADMIN'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "user_id": 4034300999,
    "email": "ipsum@example.com",
    "first_name": "pariatur ipsum",
    "last_name": "adlora amet",
    "lang": "DE",
    "role": "AGENCY-ADMIN",
    "notifications": true
  },
  "meta": {}
}

PUT

PUT /v3/customers/(customer_id: int)/access

Set access to the customer for one or more users.

In contrast to POST, this only works on existing users to which the authenticated user has access to (see /v3/users).

Can be used to grant new access as well as to change the role of already granted access. Changing roles is only allowed for users which do not have a higher access to the current customer than the request user.

Does not send out invitations to affected users!

Auth mode:

api-token

Access level:

customer-admin

Request Data (object list, json or csv)

Name	Type	Description
user_id required	Integer
role required	AssignableUserRole	The role assigned to a user on a customer.
notifications required	Boolean	If the user is allowed to see notifications for this customer.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
created	[ Object ]	List of objects which have been created.
⤷ user_id	Integer	See request data description.
⤷ email	Email	See request data description.
⤷ first_name	String	See request data description.
⤷ last_name	String	See request data description.
⤷ lang	UserLanguage	See request data description.
⤷ role	AssignableUserRole	See request data description.
⤷ notifications	Boolean	See request data description.
unchanged	[ Object ]	List of objects which had no effective change.
⤷ user_id	Integer	See request data description.
⤷ email	Email	See request data description.
⤷ first_name	String	See request data description.
⤷ last_name	String	See request data description.
⤷ lang	UserLanguage	See request data description.
⤷ role	AssignableUserRole	See request data description.
⤷ notifications	Boolean	See request data description.
updated	[ Object ]	List of objects which have been updated.
⤷ user_id	Integer	See request data description.
⤷ email	Email	See request data description.
⤷ first_name	String	See request data description.
⤷ last_name	String	See request data description.
⤷ lang	UserLanguage	See request data description.
⤷ role	AssignableUserRole	See request data description.
⤷ notifications	Boolean	See request data description.

Example

http

PUT /v3/customers/7027038674/access HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "user_id": 4034300999,
    "role": "AGENCY-ADMIN",
    "notifications": true
  }
]

curl

curl -i -X PUT https://api.adspert.net/v3/customers/7027038674/access -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"user_id": 4034300999, "role": "AGENCY-ADMIN", "notifications": true}]'

httpie

echo '[
  {
    "notifications": true,
    "role": "AGENCY-ADMIN",
    "user_id": 4034300999
  }
]' | http PUT https://api.adspert.net/v3/customers/7027038674/access Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.put('https://api.adspert.net/v3/customers/7027038674/access', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'user_id': 4034300999, 'role': 'AGENCY-ADMIN', 'notifications': True}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "created": [
      {
        "user_id": 4034300999,
        "email": "ipsum@example.com",
        "first_name": "pariatur ipsum",
        "last_name": "adlora amet",
        "lang": "DE",
        "role": "AGENCY-ADMIN",
        "notifications": true
      }
    ],
    "unchanged": [
      {
        "user_id": 4034300999,
        "email": "ipsum@example.com",
        "first_name": "pariatur ipsum",
        "last_name": "adlora amet",
        "lang": "DE",
        "role": "AGENCY-ADMIN",
        "notifications": true
      }
    ],
    "updated": [
      {
        "user_id": 4034300999,
        "email": "ipsum@example.com",
        "first_name": "pariatur ipsum",
        "last_name": "adlora amet",
        "lang": "DE",
        "role": "AGENCY-ADMIN",
        "notifications": true
      }
    ]
  },
  "meta": {}
}

DELETE

DELETE /v3/customers/(customer_id: int)/access

Remove access to the customer for one or more users.

This is only allowed for users which do not have a higher access to the current customer than the request user.

Auth mode:

api-token

Access level:

customer-admin

Request Data (object list, json or csv)

Name	Type	Description
user_id required	Integer

Response Data (single object, json or csv or xlsx)

Name	Type	Description
deleted	[ Object ]	List of objects which have been deleted.
⤷ user_id	Integer	See request data description.
⤷ email	Email	See request data description.
⤷ first_name	String	See request data description.
⤷ last_name	String	See request data description.
⤷ lang	UserLanguage	See request data description.
⤷ role	AssignableUserRole	See request data description.
⤷ notifications	Boolean	See request data description.
unknown	[ Object ]	List of objects which could not be found.
⤷ user_id	Integer	See request data description.
⤷ email	Email	See request data description.
⤷ first_name	String	See request data description.
⤷ last_name	String	See request data description.
⤷ lang	UserLanguage	See request data description.
⤷ role	AssignableUserRole	See request data description.
⤷ notifications	Boolean	See request data description.

Example

http

DELETE /v3/customers/7027038674/access HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "user_id": 4034300999
  }
]

curl

curl -i -X DELETE https://api.adspert.net/v3/customers/7027038674/access -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"user_id": 4034300999}]'

httpie

echo '[
  {
    "user_id": 4034300999
  }
]' | http DELETE https://api.adspert.net/v3/customers/7027038674/access Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.delete('https://api.adspert.net/v3/customers/7027038674/access', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'user_id': 4034300999}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "deleted": [
      {
        "user_id": 4034300999,
        "email": "ipsum@example.com",
        "first_name": "pariatur ipsum",
        "last_name": "adlora amet",
        "lang": "DE",
        "role": "AGENCY-ADMIN",
        "notifications": true
      }
    ],
    "unknown": [
      {
        "user_id": 4034300999,
        "email": "ipsum@example.com",
        "first_name": "pariatur ipsum",
        "last_name": "adlora amet",
        "lang": "DE",
        "role": "AGENCY-ADMIN",
        "notifications": true
      }
    ]
  },
  "meta": {}
}

Users

UserCollection

GET

GET /v3/users

Retrieve a list of users.

Auth mode:

api-token

Access level:

customer-admin

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_email_verified	[ Boolean ]	Only return results matching given email_verified values.
filter_sys_admin	[ Boolean ]	Only return results matching given sys_admin values.
filter_user_id	[ Integer ]	Only return results matching given user_id values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_email	String	Only return results where email matches the given string.
search_first_name	String	Only return results where first_name matches the given string.
search_last_name	String	Only return results where last_name matches the given string.
search_user_id	String	Only return results where user_id matches the given string.
sort_email	SortDirective	Sort results by email.
sort_email_verified	SortDirective	Sort results by email_verified.
sort_first_name	SortDirective	Sort results by first_name.
sort_last_name	SortDirective	Sort results by last_name.
sort_sys_admin	SortDirective	Sort results by sys_admin.
sort_user_id	SortDirective	Sort results by user_id.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
user_id searchable	Integer
email searchable	Email
email_verified	Boolean	If the user confirmed ownership of the email address. false means a confirmation is outstanding while true means there was an explicit confirmation in the past. A null value indicates implicit confirmation (e.g. for users created before email verification was enforced).
first_name searchable	String
last_name searchable	String
lang	UserLanguage	A user’s preferred language.
sys_admin	Boolean	If the user has sys admin privileges.

Example

http

GET /v3/users?offset=0&sort_first_name=7&filter_user_id=4034300999 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/users?offset=0&sort_first_name=7&filter_user_id=4034300999' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/users?offset=0&sort_first_name=7&filter_user_id=4034300999' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/users?offset=0&sort_first_name=7&filter_user_id=4034300999', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "user_id": 4034300999,
      "email": "ipsum@example.com",
      "email_verified": true,
      "first_name": "pariatur ipsum",
      "last_name": "adlora amet",
      "lang": "DE",
      "sys_admin": true
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "user_id": 1
      }
    }
  }
}

UserResource

GET

GET /v3/users/(user_id: int)

Retrieve a single user.

Currently authenticated user can be retrieved by requesting the resource for user ID 0.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
user_id	Integer
email	Email
email_verified	Boolean	If the user confirmed ownership of the email address. false means a confirmation is outstanding while true means there was an explicit confirmation in the past. A null value indicates implicit confirmation (e.g. for users created before email verification was enforced).
first_name	String
last_name	String
lang	UserLanguage	A user’s preferred language.
sys_admin	Boolean	If the user has sys admin privileges.

Example

http

GET /v3/users/4034300999?exclude=elit.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/users/4034300999?exclude=elit.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/users/4034300999?exclude=elit.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/users/4034300999?exclude=elit.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "user_id": 4034300999,
    "email": "ipsum@example.com",
    "email_verified": true,
    "first_name": "pariatur ipsum",
    "last_name": "adlora amet",
    "lang": "DE",
    "sys_admin": true
  },
  "meta": {}
}

PATCH

PATCH /v3/users/(user_id: int)

Update a user.

Non sys-admins can only modify the own user.

Auth mode:

api-token

Access level:

user

Request Data (single object, json or csv)

Name	Type	Description
email	Email
password	String	Min length: 8 Max length: 128
first_name	String
last_name	String
lang	UserLanguage	A user’s preferred language.

Example

http

PATCH /v3/users/4034300999 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

{
  "email": "ipsum@example.com",
  "password": "correct horse battery staple",
  "first_name": "pariatur ipsum",
  "last_name": "adlora amet",
  "lang": "DE"
}

curl

curl -i -X PATCH https://api.adspert.net/v3/users/4034300999 -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '{"email": "ipsum@example.com", "first_name": "pariatur ipsum", "lang": "DE", "last_name": "adlora amet", "password": "correct horse battery staple"}'

httpie

echo '{
  "email": "ipsum@example.com",
  "first_name": "pariatur ipsum",
  "lang": "DE",
  "last_name": "adlora amet",
  "password": "correct horse battery staple"
}' | http PATCH https://api.adspert.net/v3/users/4034300999 Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.patch('https://api.adspert.net/v3/users/4034300999', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json={'email': 'ipsum@example.com', 'first_name': 'pariatur ipsum', 'lang': 'DE', 'last_name': 'adlora amet', 'password': 'correct horse battery staple'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

Accounts

Routes related to advertising accounts.

Accounts are identified by their Adspert account ID in the path.

AccountResource

GET

GET /v3/accounts/(adspert_account_id: int)

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
adspert_account_id	Integer	Adspert internal ID of the advertising account
adspert_id	Integer	Adspert internal ID of the advertising account. DEPRECATED: Use adspert_account_id instead.
account_id	String
account_name	String
is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
platform	AdPlatform
platform_access_status	PlatformAccessStatus	Status of Adspert access to the ad platform for this account.
currency	String
connected_at	DateTime
optimization_start	Date	First time account has been optimized by Adspert. NULL if account hasn’t yet been optimized.
signup_completed	Boolean	Has the signup process been successfully completed? Account signup is considered completed only after first successful sync of data from the platform.
customer_id	Integer	ID of the customer that this account belongs to.
customer_name	String	Name of the customer that this account belongs to.
customer_change_target	Integer	If a customer change for this account is enqueued or in progress, this is the new customer ID. If the authenticated user does not have access to the target customer, the given ID is 0.
customer_change_started	Boolean	If a customer change for this account is currently in progress. Some customer-scoped endpoints might reject mutating requests with a 409 in this case.
default_performance_groups	Object	Default performance group settings.
⤷ optimization_type_revenue	Object	Default performance group for revenue-optimized campaigns.
⤷ performance_group_id	Integer	Unique ID of the performance group
⤷ name	String	Unique name of the performance group.
⤷ optimization_type_profit	Object	Default performance group for profit-optimized campaigns.
⤷ performance_group_id	Integer	Unique ID of the performance group
⤷ name	String	Unique name of the performance group.
⤷ optimization_type_click	Object	Default performance group for click-optimized campaigns.
⤷ performance_group_id	Integer	Unique ID of the performance group
⤷ name	String	Unique name of the performance group.
tags_user	[ String ]	List of user tags set on this account.
tags_system	[ String ]	List of system tags set on this account.
optimize	Boolean	If optimization by Adspert is enabled for this account.
disconnected	Boolean	If the account is disconnected from Adspert. While still visible here, disconnected accounts have only basic information updated and are excluded from cross-account performance endpoints. A disconnected account will be deleted completely after some time, unless snoozed is enabled. Setting this field w/o providing snoozed will automatically unset snoozed!
snoozed	Boolean	A snoozed account is a disconnected account which won’t be deleted automatically. Setting this field w/o providing disconnected will automatically set disconnected to the same value!
conversion_value	Micros	Average value of a conversion in this account, which will be used by the optimization in case conversion values are not reported by the advertising platform. Campaign specific conversion values may override this.
conversion_value_source	ConversionValueSource	Source of the conversion value e.g., platform, manual and product
conversion_value_type	ConversionValueType	Type of the conversion value e.g., revenue and profit
click_optimization	Boolean	If the account is set for click optimization
attention_score	Float	A magic score to order ad accounts by the attention they need. The higher the score, the more settings need to be tweaked or problems need to be solved for that account.
campaign_count_total	Integer	Number of non-deleted campaigns in the ad acccount.
campaign_count_active	Integer	Number of active campaigns in the ad acccount.
campaign_count_optimized	Integer	Number of campaigns in the ad account which are active and optimized by Adspert.
amz_account_type	AmazonAccountType	Amazon Ads account type. NULL if it’s not an Amazon Ads account.
amz_region	AmzEndpoint	Amazon Region. NULL if the account is not an Amazon account.
product_feed_url	[ String ]	Product feed URL for the account
conversions_last_30d	Float	Number of conversions. Always 0 for click optimized campaigns.

Example

http

GET /v3/accounts/3420379091?exclude=elit.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/accounts/3420379091?exclude=elit.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/accounts/3420379091?exclude=elit.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/accounts/3420379091?exclude=elit.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "adspert_account_id": 123,
    "adspert_id": 123,
    "account_id": "amet lorem",
    "account_name": "vehicula ipsum",
    "is_demo": true,
    "platform": "AMAZON",
    "platform_access_status": "ACCOUNT-DISABLED",
    "currency": "elit tucan",
    "connected_at": "2018-10-21T16:45:23+02:00",
    "optimization_start": "2018-10-21",
    "signup_completed": true,
    "customer_id": 2022024680,
    "customer_name": "amet sit",
    "customer_change_target": 2022024680,
    "customer_change_started": true,
    "default_performance_groups": {
      "optimization_type_revenue": {
        "performance_group_id": "1245",
        "name": "tucan lorem"
      },
      "optimization_type_profit": {
        "performance_group_id": "1245",
        "name": "tucan lorem"
      },
      "optimization_type_click": {
        "performance_group_id": "1245",
        "name": "tucan lorem"
      }
    },
    "tags_user": [
      "dolor elit"
    ],
    "tags_system": [
      "dolor vehicula"
    ],
    "optimize": true,
    "disconnected": true,
    "snoozed": true,
    "conversion_value": 150000,
    "conversion_value_source": "MANUAL",
    "conversion_value_type": "PROFIT",
    "click_optimization": true,
    "attention_score": 0.56,
    "campaign_count_total": 7260538450,
    "campaign_count_active": 2868857587,
    "campaign_count_optimized": 5352721934,
    "amz_account_type": "AGENCY",
    "amz_region": "EU",
    "product_feed_url": [
      "adlora dolor"
    ],
    "conversions_last_30d": 6.62
  },
  "meta": {}
}

PATCH

PATCH /v3/accounts/(adspert_account_id: int)

Auth mode:

api-token

Access level:

user

Request Data (single object, json or csv)

Name	Type	Description
optimize	Boolean	If optimization by Adspert is enabled for this account.
conversion_value	Micros	Average value of a conversion in this account, which will be used by the optimization in case conversion values are not reported by the advertising platform. Campaign specific conversion values may override this. Min value: 1000
disconnected	Boolean	If the account is disconnected from Adspert. While still visible here, disconnected accounts have only basic information updated and are excluded from cross-account performance endpoints. A disconnected account will be deleted completely after some time, unless snoozed is enabled. Setting this field w/o providing snoozed will automatically unset snoozed!
snoozed	Boolean	A snoozed account is a disconnected account which won’t be deleted automatically. Setting this field w/o providing disconnected will automatically set disconnected to the same value!
conversion_value_source	ConversionValueSource	Source of the conversion value e.g., platform, manual and product
conversion_value_type	ConversionValueType	Type of the conversion value e.g., revenue and profit
click_optimization	Boolean	If the account is set for click optimization
conversion_value_factor	Float	Conversion value factor

Example

http

PATCH /v3/accounts/3420379091 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

{
  "optimize": true,
  "conversion_value": 150000,
  "disconnected": true,
  "snoozed": true,
  "conversion_value_source": "MANUAL",
  "conversion_value_type": "PROFIT",
  "click_optimization": true,
  "conversion_value_factor": 1.09
}

curl

curl -i -X PATCH https://api.adspert.net/v3/accounts/3420379091 -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '{"click_optimization": true, "conversion_value": 150000, "conversion_value_factor": 1.09, "conversion_value_source": "MANUAL", "conversion_value_type": "PROFIT", "disconnected": true, "optimize": true, "snoozed": true}'

httpie

echo '{
  "click_optimization": true,
  "conversion_value": 150000,
  "conversion_value_factor": 1.09,
  "conversion_value_source": "MANUAL",
  "conversion_value_type": "PROFIT",
  "disconnected": true,
  "optimize": true,
  "snoozed": true
}' | http PATCH https://api.adspert.net/v3/accounts/3420379091 Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.patch('https://api.adspert.net/v3/accounts/3420379091', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json={'click_optimization': True, 'conversion_value': 150000, 'conversion_value_factor': 1.09, 'conversion_value_source': 'MANUAL', 'conversion_value_type': 'PROFIT', 'disconnected': True, 'optimize': True, 'snoozed': True})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

AccountCollection

GET

GET /v3/accounts

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_adspert_id	[ Integer ]	Only return results matching given adspert_id values.
filter_amz_account_type	[ AmazonAccountType ]	Only return results matching given amz_account_type values.
filter_amz_region	[ AmzEndpoint ]	Only return results matching given amz_region values.
filter_click_optimization	[ Boolean ]	Only return results matching given click_optimization values.
filter_conversion_value	[ Micros ]	Only return results matching given conversion_value values. Min value: 1000
filter_conversion_value_source	[ ConversionValueSource ]	Only return results matching given conversion_value_source values.
filter_conversion_value_type	[ ConversionValueType ]	Only return results matching given conversion_value_type values.
filter_conversions_last_30d	[ Float ]	Only return results matching given conversions_last_30d values.
filter_currency	[ String ]	Only return results matching given currency values.
filter_customer_change_target	[ Integer ]	Only return results matching given customer_change_target values.
filter_customer_id	[ Integer ]	Only return results matching given customer_id values.
filter_disconnected	[ Boolean ]	Only return results matching given disconnected values.
filter_is_demo	[ Boolean ]	Only return results matching given is_demo values.
filter_optimize	[ Boolean ]	Only return results matching given optimize values.
filter_platform	[ AdPlatform ]	Only return results matching given platform values.
filter_platform_access_status	[ PlatformAccessStatus ]	Only return results matching given platform_access_status values.
filter_product_feed_url	[ String ]	Only return results matching given product_feed_url values.
filter_product_feed_url_set	[ Boolean ]	Only return results matching given product_feed_url_set values.
filter_signup_completed	[ Boolean ]	Only return results matching given signup_completed values.
filter_snoozed	[ Boolean ]	Only return results matching given snoozed values.
filter_tags_system	[ String ]	Only return results matching given tags_system values.
filter_tags_user	[ String ]	Only return results matching given tags_user values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_adspert_id	String	Only return results where adspert_id matches the given string.
search_customer_name	String	Only return results where customer_name matches the given string.
search_product_feed_url	String	Only return results where product_feed_url matches the given string.
search_tags_system	String	Only return results where tags_system matches the given string.
search_tags_user	String	Only return results where tags_user matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_name	SortDirective	Sort results by account_name.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_adspert_id	SortDirective	Sort results by adspert_id.
sort_amz_account_type	SortDirective	Sort results by amz_account_type.
sort_amz_region	SortDirective	Sort results by amz_region.
sort_attention_score	SortDirective	Sort results by attention_score.
sort_campaign_count_active	SortDirective	Sort results by campaign_count_active.
sort_campaign_count_optimized	SortDirective	Sort results by campaign_count_optimized.
sort_campaign_count_total	SortDirective	Sort results by campaign_count_total.
sort_click_optimization	SortDirective	Sort results by click_optimization.
sort_connected_at	SortDirective	Sort results by connected_at.
sort_conversion_value	SortDirective	Sort results by conversion_value.
sort_conversion_value_source	SortDirective	Sort results by conversion_value_source.
sort_conversion_value_type	SortDirective	Sort results by conversion_value_type.
sort_conversions_last_30d	SortDirective	Sort results by conversions_last_30d.
sort_currency	SortDirective	Sort results by currency.
sort_customer_change_target	SortDirective	Sort results by customer_change_target.
sort_customer_id	SortDirective	Sort results by customer_id.
sort_customer_name	SortDirective	Sort results by customer_name.
sort_disconnected	SortDirective	Sort results by disconnected.
sort_is_demo	SortDirective	Sort results by is_demo.
sort_optimization_start	SortDirective	Sort results by optimization_start.
sort_optimize	SortDirective	Sort results by optimize.
sort_platform	SortDirective	Sort results by platform.
sort_platform_access_status	SortDirective	Sort results by platform_access_status.
sort_product_feed_url	SortDirective	Sort results by product_feed_url.
sort_snoozed	SortDirective	Sort results by snoozed.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
adspert_id searchable	Integer	Adspert internal ID of the advertising account. DEPRECATED: Use adspert_account_id instead.
account_id searchable	String
account_name searchable	String
is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
platform	AdPlatform
platform_access_status	PlatformAccessStatus	Status of Adspert access to the ad platform for this account.
currency	String
connected_at	DateTime
optimization_start	Date	First time account has been optimized by Adspert. NULL if account hasn’t yet been optimized.
signup_completed	Boolean	Has the signup process been successfully completed? Account signup is considered completed only after first successful sync of data from the platform.
customer_id	Integer	ID of the customer that this account belongs to.
customer_name searchable	String	Name of the customer that this account belongs to.
customer_change_target	Integer	If a customer change for this account is enqueued or in progress, this is the new customer ID. If the authenticated user does not have access to the target customer, the given ID is 0.
customer_change_started	Boolean	If a customer change for this account is currently in progress. Some customer-scoped endpoints might reject mutating requests with a 409 in this case.
default_performance_groups	Object	Default performance group settings.
⤷ optimization_type_revenue	Object	Default performance group for revenue-optimized campaigns.
⤷ performance_group_id searchable	Integer	Unique ID of the performance group
⤷ name searchable	String	Unique name of the performance group.
⤷ optimization_type_profit	Object	Default performance group for profit-optimized campaigns.
⤷ performance_group_id searchable	Integer	Unique ID of the performance group
⤷ name searchable	String	Unique name of the performance group.
⤷ optimization_type_click	Object	Default performance group for click-optimized campaigns.
⤷ performance_group_id searchable	Integer	Unique ID of the performance group
⤷ name searchable	String	Unique name of the performance group.
tags_user searchable	[ String ]	List of user tags set on this account.
tags_system searchable	[ String ]	List of system tags set on this account.
optimize	Boolean	If optimization by Adspert is enabled for this account.
disconnected	Boolean	If the account is disconnected from Adspert. While still visible here, disconnected accounts have only basic information updated and are excluded from cross-account performance endpoints. A disconnected account will be deleted completely after some time, unless snoozed is enabled. Setting this field w/o providing snoozed will automatically unset snoozed!
snoozed	Boolean	A snoozed account is a disconnected account which won’t be deleted automatically. Setting this field w/o providing disconnected will automatically set disconnected to the same value!
conversion_value	Micros	Average value of a conversion in this account, which will be used by the optimization in case conversion values are not reported by the advertising platform. Campaign specific conversion values may override this.
conversion_value_source	ConversionValueSource	Source of the conversion value e.g., platform, manual and product
conversion_value_type	ConversionValueType	Type of the conversion value e.g., revenue and profit
click_optimization	Boolean	If the account is set for click optimization
attention_score	Float	A magic score to order ad accounts by the attention they need. The higher the score, the more settings need to be tweaked or problems need to be solved for that account.
campaign_count_total	Integer	Number of non-deleted campaigns in the ad acccount.
campaign_count_active	Integer	Number of active campaigns in the ad acccount.
campaign_count_optimized	Integer	Number of campaigns in the ad account which are active and optimized by Adspert.
amz_account_type	AmazonAccountType	Amazon Ads account type. NULL if it’s not an Amazon Ads account.
amz_region	AmzEndpoint	Amazon Region. NULL if the account is not an Amazon account.
product_feed_url searchable	[ String ]	Product feed URL for the account
conversions_last_30d	Float	Number of conversions. Always 0 for click optimized campaigns.

Example

http

GET /v3/accounts?search_account_name=sit+tucan&filter_disconnected=True&sort_amz_account_type=0 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/accounts?search_account_name=sit+tucan&filter_disconnected=True&sort_amz_account_type=0' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/accounts?search_account_name=sit+tucan&filter_disconnected=True&sort_amz_account_type=0' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/accounts?search_account_name=sit+tucan&filter_disconnected=True&sort_amz_account_type=0', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "adspert_account_id": 123,
      "adspert_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "is_demo": true,
      "platform": "AMAZON",
      "platform_access_status": "ACCOUNT-DISABLED",
      "currency": "elit tucan",
      "connected_at": "2018-10-21T16:45:23+02:00",
      "optimization_start": "2018-10-21",
      "signup_completed": true,
      "customer_id": 2022024680,
      "customer_name": "amet sit",
      "customer_change_target": 2022024680,
      "customer_change_started": true,
      "default_performance_groups": {
        "optimization_type_revenue": {
          "performance_group_id": "1245",
          "name": "tucan lorem"
        },
        "optimization_type_profit": {
          "performance_group_id": "1245",
          "name": "tucan lorem"
        },
        "optimization_type_click": {
          "performance_group_id": "1245",
          "name": "tucan lorem"
        }
      },
      "tags_user": [
        "dolor elit"
      ],
      "tags_system": [
        "dolor vehicula"
      ],
      "optimize": true,
      "disconnected": true,
      "snoozed": true,
      "conversion_value": 150000,
      "conversion_value_source": "MANUAL",
      "conversion_value_type": "PROFIT",
      "click_optimization": true,
      "attention_score": 0.56,
      "campaign_count_total": 7260538450,
      "campaign_count_active": 2868857587,
      "campaign_count_optimized": 5352721934,
      "amz_account_type": "AGENCY",
      "amz_region": "EU",
      "product_feed_url": [
        "adlora dolor"
      ],
      "conversions_last_30d": 6.62
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "adspert_account_id": 1
      }
    }
  }
}

PATCH

PATCH /v3/accounts

Auth mode:

api-token

Access level:

user

Request Data (object list, json or csv)

Name	Type	Description
adspert_id	Integer	Adspert internal ID of the advertising account
conversion_value_source	ConversionValueSource	Source of the conversion value e.g., platform, manual and product
conversion_value_type	ConversionValueType	Type of the conversion value e.g., revenue and profit
click_optimization	Boolean	If the account is set for click optimization
conversion_value	Micros	Average value of a conversion in this account, which will be used by the optimization in case conversion values are not reported by the advertising platform. Campaign specific conversion values may override this. Min value: 1000
conversion_value_factor	Float	Conversion value factor

Response Data (single object, json or csv or xlsx)

Name	Type	Description
unchanged	[ Object ]	List of objects which had no effective change.
⤷ adspert_id	Integer	See request data description.
⤷ conversion_value_source	ConversionValueSource	See request data description.
⤷ conversion_value_type	ConversionValueType	See request data description.
⤷ click_optimization	Boolean	See request data description.
⤷ conversion_value	Micros	See request data description.
⤷ conversion_value_factor	Float	See request data description.
unknown	[ Object ]	List of objects which could not be found.
⤷ adspert_id	Integer	See request data description.
⤷ conversion_value_source	ConversionValueSource	See request data description.
⤷ conversion_value_type	ConversionValueType	See request data description.
⤷ click_optimization	Boolean	See request data description.
⤷ conversion_value	Micros	See request data description.
⤷ conversion_value_factor	Float	See request data description.
updated	[ Object ]	List of objects which have been updated.
⤷ adspert_id	Integer	See request data description.
⤷ conversion_value_source	ConversionValueSource	See request data description.
⤷ conversion_value_type	ConversionValueType	See request data description.
⤷ click_optimization	Boolean	See request data description.
⤷ conversion_value	Micros	See request data description.
⤷ conversion_value_factor	Float	See request data description.

Example

http

PATCH /v3/accounts HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "adspert_id": 123,
    "conversion_value_source": "MANUAL",
    "conversion_value_type": "PROFIT",
    "click_optimization": true,
    "conversion_value": 150000,
    "conversion_value_factor": 1.09
  }
]

curl

curl -i -X PATCH https://api.adspert.net/v3/accounts -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"adspert_id": 123, "conversion_value_source": "MANUAL", "conversion_value_type": "PROFIT", "click_optimization": true, "conversion_value": 150000, "conversion_value_factor": 1.09}]'

httpie

echo '[
  {
    "adspert_id": 123,
    "click_optimization": true,
    "conversion_value": 150000,
    "conversion_value_factor": 1.09,
    "conversion_value_source": "MANUAL",
    "conversion_value_type": "PROFIT"
  }
]' | http PATCH https://api.adspert.net/v3/accounts Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.patch('https://api.adspert.net/v3/accounts', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'adspert_id': 123, 'conversion_value_source': 'MANUAL', 'conversion_value_type': 'PROFIT', 'click_optimization': True, 'conversion_value': 150000, 'conversion_value_factor': 1.09}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "unchanged": [
      {
        "adspert_id": 123,
        "conversion_value_source": "MANUAL",
        "conversion_value_type": "PROFIT",
        "click_optimization": true,
        "conversion_value": 150000,
        "conversion_value_factor": 1.09
      }
    ],
    "unknown": [
      {
        "adspert_id": 123,
        "conversion_value_source": "MANUAL",
        "conversion_value_type": "PROFIT",
        "click_optimization": true,
        "conversion_value": 150000,
        "conversion_value_factor": 1.09
      }
    ],
    "updated": [
      {
        "adspert_id": 123,
        "conversion_value_source": "MANUAL",
        "conversion_value_type": "PROFIT",
        "click_optimization": true,
        "conversion_value": 150000,
        "conversion_value_factor": 1.09
      }
    ]
  },
  "meta": {}
}

AccountTagCollection

GET

GET /v3/accounts/tags

Retrieve a list of account tags.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_customer_id	[ Integer ]	Only return results matching given customer_id values.
filter_tag_name	[ String ]	Only return results matching given tag_name values.
filter_tag_scope	[ AccountTagScope ]	Only return results matching given tag_scope values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_tag_name	String	Only return results where tag_name matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_name	SortDirective	Sort results by account_name.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_customer_id	SortDirective	Sort results by customer_id.
sort_tag_name	SortDirective	Sort results by tag_name.
sort_tag_scope	SortDirective	Sort results by tag_scope.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
customer_id	Integer	ID of the customer that the tagged account belongs to.
customer_name	String	Name of the customer that the tagged account belongs to.
adspert_account_id	Integer	Adspert internal ID of the advertising account
account_id searchable	String
account_name searchable	String
tag_name searchable	String	Name of the tag (must not contain white space).
tag_scope	AccountTagScope	Scope of the tag. System-scope tags are read-only!

Example

http

GET /v3/accounts/tags?sort_tag_scope=-6&offset=0&sort_account_id=7 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/accounts/tags?sort_tag_scope=-6&offset=0&sort_account_id=7' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/accounts/tags?sort_tag_scope=-6&offset=0&sort_account_id=7' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/accounts/tags?sort_tag_scope=-6&offset=0&sort_account_id=7', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "customer_id": 7027038674,
      "customer_name": "amet sit",
      "adspert_account_id": 3420379091,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "tag_name": "shopping",
      "tag_scope": "ADMIN"
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "customer_id": 1
      }
    }
  }
}

PUT

PUT /v3/accounts/tags

Set a list of account tags.

Auth mode:

api-token

Access level:

user

Request Data (object list, json or csv)

Name	Type	Description
customer_id	Integer	ID of the customer that the tagged account belongs to.
adspert_account_id	Integer	Adspert internal ID of the advertising account
tag_name	String	Name of the tag (must not contain white space).
tag_scope	AccountTagScope	Scope of the tag. System-scope tags are read-only! Default: USER

Response Data (single object, json or csv or xlsx)

Name	Type	Description
created	[ Object ]	List of objects which have been created.
⤷ customer_id	Integer	See request data description.
⤷ adspert_account_id	Integer	See request data description.
⤷ tag_name	String	See request data description.
⤷ tag_scope	AccountTagScope	See request data description.
unchanged	[ Object ]	List of objects which had no effective change.
⤷ customer_id	Integer	See request data description.
⤷ adspert_account_id	Integer	See request data description.
⤷ tag_name	String	See request data description.
⤷ tag_scope	AccountTagScope	See request data description.
updated	[ Object ]	List of objects which have been updated.
⤷ customer_id	Integer	See request data description.
⤷ adspert_account_id	Integer	See request data description.
⤷ tag_name	String	See request data description.
⤷ tag_scope	AccountTagScope	See request data description.

Example

http

PUT /v3/accounts/tags HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "customer_id": 7027038674,
    "adspert_account_id": 3420379091,
    "tag_name": "shopping",
    "tag_scope": "ADMIN"
  }
]

curl

curl -i -X PUT https://api.adspert.net/v3/accounts/tags -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"customer_id": 7027038674, "adspert_account_id": 3420379091, "tag_name": "shopping", "tag_scope": "ADMIN"}]'

httpie

echo '[
  {
    "adspert_account_id": 3420379091,
    "customer_id": 7027038674,
    "tag_name": "shopping",
    "tag_scope": "ADMIN"
  }
]' | http PUT https://api.adspert.net/v3/accounts/tags Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.put('https://api.adspert.net/v3/accounts/tags', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'customer_id': 7027038674, 'adspert_account_id': 3420379091, 'tag_name': 'shopping', 'tag_scope': 'ADMIN'}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "created": [
      {
        "customer_id": 7027038674,
        "adspert_account_id": 3420379091,
        "tag_name": "shopping",
        "tag_scope": "ADMIN"
      }
    ],
    "unchanged": [
      {
        "customer_id": 7027038674,
        "adspert_account_id": 3420379091,
        "tag_name": "shopping",
        "tag_scope": "ADMIN"
      }
    ],
    "updated": [
      {
        "customer_id": 7027038674,
        "adspert_account_id": 3420379091,
        "tag_name": "shopping",
        "tag_scope": "ADMIN"
      }
    ]
  },
  "meta": {}
}

DELETE

DELETE /v3/accounts/tags

Delete a list of account tags.

Auth mode:

api-token

Access level:

user

Request Data (object list, json or csv)

Name	Type	Description
customer_id	Integer	ID of the customer that the tagged account belongs to.
adspert_account_id	Integer	Adspert internal ID of the advertising account
tag_name	String	Name of the tag (must not contain white space).
tag_scope	AccountTagScope	Scope of the tag. System-scope tags are read-only! Default: USER

Response Data (single object, json or csv or xlsx)

Name	Type	Description
deleted	[ Object ]	List of objects which have been deleted.
⤷ customer_id	Integer	See request data description.
⤷ adspert_account_id	Integer	See request data description.
⤷ tag_name	String	See request data description.
⤷ tag_scope	AccountTagScope	See request data description.
unknown	[ Object ]	List of objects which could not be found.
⤷ customer_id	Integer	See request data description.
⤷ adspert_account_id	Integer	See request data description.
⤷ tag_name	String	See request data description.
⤷ tag_scope	AccountTagScope	See request data description.

Example

http

DELETE /v3/accounts/tags HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "customer_id": 7027038674,
    "adspert_account_id": 3420379091,
    "tag_name": "shopping",
    "tag_scope": "ADMIN"
  }
]

curl

curl -i -X DELETE https://api.adspert.net/v3/accounts/tags -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"customer_id": 7027038674, "adspert_account_id": 3420379091, "tag_name": "shopping", "tag_scope": "ADMIN"}]'

httpie

echo '[
  {
    "adspert_account_id": 3420379091,
    "customer_id": 7027038674,
    "tag_name": "shopping",
    "tag_scope": "ADMIN"
  }
]' | http DELETE https://api.adspert.net/v3/accounts/tags Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.delete('https://api.adspert.net/v3/accounts/tags', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'customer_id': 7027038674, 'adspert_account_id': 3420379091, 'tag_name': 'shopping', 'tag_scope': 'ADMIN'}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "deleted": [
      {
        "customer_id": 7027038674,
        "adspert_account_id": 3420379091,
        "tag_name": "shopping",
        "tag_scope": "ADMIN"
      }
    ],
    "unknown": [
      {
        "customer_id": 7027038674,
        "adspert_account_id": 3420379091,
        "tag_name": "shopping",
        "tag_scope": "ADMIN"
      }
    ]
  },
  "meta": {}
}

Structure

Structure objects in ad accounts (campaigns, products, …).

PerformanceGroupCollection

GET

GET /v3/customers/(customer_id: int)/performance-groups

Retrieve a list of performance groups.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_campaign_id	[ LargeInteger ]	Only return results matching given campaign_id values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_amz_targeting_type	[ AmzTargetingType ]	Only return results matching given campaign_amz_targeting_type values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_enabled	[ Boolean ]	Only return results matching given enabled values.
filter_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given goal_types values.
filter_name	[ String ]	Only return results matching given name values.
filter_optimization_type	[ OptimizationType ]	Only return results matching given optimization_type values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_warning_status	[ PerformanceGroupWarningStatus ]	Only return results matching given warning_status values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_name	String	Only return results where name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
sort_created_at	SortDirective	Sort results by created_at.
sort_enabled	SortDirective	Sort results by enabled.
sort_goal_types	SortDirective	Sort results by goal_types.
sort_name	SortDirective	Sort results by name.
sort_optimization_type	SortDirective	Sort results by optimization_type.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_warning_status	SortDirective	Sort results by warning_status.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
performance_group_id searchable	Integer	Unique ID of the performance group
name searchable	String	Unique name of the performance group.
optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
enabled	Boolean
created_at	DateTime
goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
campaigns	[ CompositeID ]	List of campaigns that belong to the performance group. Each item in the list is a composite id: {adspert_id}:{campaign_id}.
warnings	[ Object ]
⤷ type	PerformanceGroupWarningType	Type of the warning
⤷ priority	PerformanceGroupWarningPriority	Priority of the warning
⤷ adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id searchable	LargeInteger
⤷ created_at	DateTime
⤷ acknowledged_at	DateTime
warning_status	PerformanceGroupWarningStatus	Status that summarizes all warnings associated with this performance group.
default_for_accounts	[ Integer ]	List of accounts that use this performance group as a default for newly added campaigns. Each item in the list is an adspert_account_id.
user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.

Example

http

GET /v3/customers/7027038674/performance-groups?filter_campaign_optimization_type=CLICK&search_account_id=elit+dolor&sort_enabled=-8 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/performance-groups?filter_campaign_optimization_type=CLICK&search_account_id=elit+dolor&sort_enabled=-8' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/performance-groups?filter_campaign_optimization_type=CLICK&search_account_id=elit+dolor&sort_enabled=-8' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/performance-groups?filter_campaign_optimization_type=CLICK&search_account_id=elit+dolor&sort_enabled=-8', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "performance_group_id": "1245",
      "name": "tucan lorem",
      "optimization_type": "CLICK",
      "enabled": true,
      "created_at": "2018-10-21T16:45:23+02:00",
      "goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "goal_types": [
        "CLICKS-PER-DAY"
      ],
      "campaigns": [
        "123:5555"
      ],
      "warnings": [
        {
          "type": "ACCOUNT-API-ACCESS-NONE",
          "priority": "HIGH",
          "adspert_account_id": 123,
          "adspert_campaign_id": "123:5555",
          "campaign_id": "5555",
          "created_at": "2018-10-21T16:45:23+02:00",
          "acknowledged_at": "2018-10-21T16:45:23+02:00"
        }
      ],
      "warning_status": "ACKNOWLEDGED",
      "default_for_accounts": [
        123
      ],
      "user_max_bid": {
        "micros": 8340000,
        "currency": "AED"
      }
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "performance_group_id": 1
      }
    }
  }
}

POST

POST /v3/customers/(customer_id: int)/performance-groups

Create a new performance group.

Responds with a 409 (Conflict) if accounts of this customer are currently moved to another customer. During that time customer-level setting changes are not allowed.

Auth mode:

api-token

Access level:

user

Request Data (single object, json)

Name	Type	Description
name required	String	Unique name of the performance group.
optimization_type required	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
enabled required	Boolean
goals required	[ Object ]	List of performance group goals
⤷ goal_type required	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
campaigns	[ CompositeID ]	List of campaigns that belong to the performance group. Each item in the list is a composite id: {adspert_id}:{campaign_id}.
default_for_accounts	[ Integer ]	List of accounts that use this performance group as a default for newly added campaigns. Each item in the list is an adspert_account_id.
user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros required	Micros	Monetary value in micros. Min value: 1000
⤷ currency required	Currency	Currency of the monetary value.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
performance_group_id	Integer	Unique ID of the performance group
name	String	Unique name of the performance group.
optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
enabled	Boolean
created_at	DateTime
goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
campaigns	[ CompositeID ]	List of campaigns that belong to the performance group. Each item in the list is a composite id: {adspert_id}:{campaign_id}.
warnings	[ Object ]
⤷ type	PerformanceGroupWarningType	Type of the warning
⤷ priority	PerformanceGroupWarningPriority	Priority of the warning
⤷ adspert_account_id	Integer	Adspert internal ID of the advertising account
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id	LargeInteger
⤷ created_at	DateTime
⤷ acknowledged_at	DateTime
warning_status	PerformanceGroupWarningStatus	Status that summarizes all warnings associated with this performance group.
default_for_accounts	[ Integer ]	List of accounts that use this performance group as a default for newly added campaigns. Each item in the list is an adspert_account_id.
user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.

Example

http

POST /v3/customers/7027038674/performance-groups HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

{
  "name": "tucan lorem",
  "optimization_type": "CLICK",
  "enabled": true,
  "goals": [
    {
      "goal_type": "CLICKS-PER-DAY",
      "goal_value": 1.41,
      "goal_currency": "AED"
    }
  ],
  "campaigns": [
    "123:5555"
  ],
  "default_for_accounts": [
    123
  ],
  "user_max_bid": {
    "micros": 8340000,
    "currency": "AED"
  }
}

curl

curl -i -X POST https://api.adspert.net/v3/customers/7027038674/performance-groups -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '{"campaigns": ["123:5555"], "default_for_accounts": [123], "enabled": true, "goals": [{"goal_type": "CLICKS-PER-DAY", "goal_value": 1.41, "goal_currency": "AED"}], "name": "tucan lorem", "optimization_type": "CLICK", "user_max_bid": {"currency": "AED", "micros": 8340000}}'

httpie

echo '{
  "campaigns": [
    "123:5555"
  ],
  "default_for_accounts": [
    123
  ],
  "enabled": true,
  "goals": [
    {
      "goal_currency": "AED",
      "goal_type": "CLICKS-PER-DAY",
      "goal_value": 1.41
    }
  ],
  "name": "tucan lorem",
  "optimization_type": "CLICK",
  "user_max_bid": {
    "currency": "AED",
    "micros": 8340000
  }
}' | http POST https://api.adspert.net/v3/customers/7027038674/performance-groups Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.post('https://api.adspert.net/v3/customers/7027038674/performance-groups', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json={'campaigns': ['123:5555'], 'default_for_accounts': [123], 'enabled': True, 'goals': [{'goal_type': 'CLICKS-PER-DAY', 'goal_value': 1.41, 'goal_currency': 'AED'}], 'name': 'tucan lorem', 'optimization_type': 'CLICK', 'user_max_bid': {'currency': 'AED', 'micros': 8340000}})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "performance_group_id": "1245",
    "name": "tucan lorem",
    "optimization_type": "CLICK",
    "enabled": true,
    "created_at": "2018-10-21T16:45:23+02:00",
    "goals": [
      {
        "goal_type": "CLICKS-PER-DAY",
        "goal_value": 1.41,
        "goal_currency": "AED",
        "goal_micros": 6300000,
        "goal_ratio": 8.77
      }
    ],
    "goal_types": [
      "CLICKS-PER-DAY"
    ],
    "campaigns": [
      "123:5555"
    ],
    "warnings": [
      {
        "type": "ACCOUNT-API-ACCESS-NONE",
        "priority": "HIGH",
        "adspert_account_id": 123,
        "adspert_campaign_id": "123:5555",
        "campaign_id": "5555",
        "created_at": "2018-10-21T16:45:23+02:00",
        "acknowledged_at": "2018-10-21T16:45:23+02:00"
      }
    ],
    "warning_status": "ACKNOWLEDGED",
    "default_for_accounts": [
      123
    ],
    "user_max_bid": {
      "micros": 8340000,
      "currency": "AED"
    }
  },
  "meta": {}
}

PATCH

PATCH /v3/customers/(customer_id: int)/performance-groups

Update a collection of performance groups.

Responds with a 409 (Conflict) if accounts of this customer are currently moved to another customer. During that time customer-level setting changes are not allowed.

Auth mode:

api-token

Access level:

user

Request Data (object list, json)

Name	Type	Description
performance_group_id required	Integer	Unique ID of the performance group
name	String	Unique name of the performance group.
enabled	Boolean
goals	[ Object ]	List of performance group goals
⤷ goal_type required	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
campaigns	[ CompositeID ]	List of campaigns that belong to the performance group. Each item in the list is a composite id: {adspert_id}:{campaign_id}.
default_for_accounts	[ Integer ]	List of accounts that use this performance group as a default for newly added campaigns. Each item in the list is an adspert_account_id.
acknowledge_warnings	Boolean	Acknowledge performance group warnings. Acknowledging a warning results in either marking that warning as acknowledged (with a timestamp) or deleting it. ApiPerformanceGroupWarningType description can be used to find out which warnings are deleted on acknowledgement.
user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros required	Micros	Monetary value in micros. Min value: 1000
⤷ currency required	Currency	Currency of the monetary value.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
unchanged	[ Object ]	List of objects which had no effective change.
⤷ performance_group_id	Integer	See request data description.
⤷ name	String	See request data description.
⤷ enabled	Boolean	See request data description.
⤷ goals	[ Object ]	See request data description.
⤷ goal_type	PerformanceGroupGoalType	See request data description.
⤷ goal_value	Float	See request data description.
⤷ goal_currency	Currency	See request data description.
⤷ campaigns	[ CompositeID ]	See request data description.
⤷ default_for_accounts	[ Integer ]	See request data description.
⤷ acknowledge_warnings	Boolean	See request data description.
⤷ user_max_bid	Object	See request data description.
⤷ micros	Micros	See request data description.
⤷ currency	Currency	See request data description.
unknown	[ Object ]	List of objects which could not be found.
⤷ performance_group_id	Integer	See request data description.
⤷ name	String	See request data description.
⤷ enabled	Boolean	See request data description.
⤷ goals	[ Object ]	See request data description.
⤷ goal_type	PerformanceGroupGoalType	See request data description.
⤷ goal_value	Float	See request data description.
⤷ goal_currency	Currency	See request data description.
⤷ campaigns	[ CompositeID ]	See request data description.
⤷ default_for_accounts	[ Integer ]	See request data description.
⤷ acknowledge_warnings	Boolean	See request data description.
⤷ user_max_bid	Object	See request data description.
⤷ micros	Micros	See request data description.
⤷ currency	Currency	See request data description.
updated	[ Object ]	List of objects which have been updated.
⤷ performance_group_id	Integer	See request data description.
⤷ name	String	See request data description.
⤷ enabled	Boolean	See request data description.
⤷ goals	[ Object ]	See request data description.
⤷ goal_type	PerformanceGroupGoalType	See request data description.
⤷ goal_value	Float	See request data description.
⤷ goal_currency	Currency	See request data description.
⤷ campaigns	[ CompositeID ]	See request data description.
⤷ default_for_accounts	[ Integer ]	See request data description.
⤷ acknowledge_warnings	Boolean	See request data description.
⤷ user_max_bid	Object	See request data description.
⤷ micros	Micros	See request data description.
⤷ currency	Currency	See request data description.

Example

http

PATCH /v3/customers/7027038674/performance-groups HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "performance_group_id": "1245",
    "name": "tucan lorem",
    "enabled": true,
    "goals": [
      {
        "goal_type": "CLICKS-PER-DAY",
        "goal_value": 1.41,
        "goal_currency": "AED"
      }
    ],
    "campaigns": [
      "123:5555"
    ],
    "default_for_accounts": [
      123
    ],
    "acknowledge_warnings": true,
    "user_max_bid": {
      "micros": 8340000,
      "currency": "AED"
    }
  }
]

curl

curl -i -X PATCH https://api.adspert.net/v3/customers/7027038674/performance-groups -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"performance_group_id": "1245", "name": "tucan lorem", "enabled": true, "goals": [{"goal_type": "CLICKS-PER-DAY", "goal_value": 1.41, "goal_currency": "AED"}], "campaigns": ["123:5555"], "default_for_accounts": [123], "acknowledge_warnings": true, "user_max_bid": {"micros": 8340000, "currency": "AED"}}]'

httpie

echo '[
  {
    "acknowledge_warnings": true,
    "campaigns": [
      "123:5555"
    ],
    "default_for_accounts": [
      123
    ],
    "enabled": true,
    "goals": [
      {
        "goal_currency": "AED",
        "goal_type": "CLICKS-PER-DAY",
        "goal_value": 1.41
      }
    ],
    "name": "tucan lorem",
    "performance_group_id": "1245",
    "user_max_bid": {
      "currency": "AED",
      "micros": 8340000
    }
  }
]' | http PATCH https://api.adspert.net/v3/customers/7027038674/performance-groups Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.patch('https://api.adspert.net/v3/customers/7027038674/performance-groups', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'performance_group_id': '1245', 'name': 'tucan lorem', 'enabled': True, 'goals': [{'goal_type': 'CLICKS-PER-DAY', 'goal_value': 1.41, 'goal_currency': 'AED'}], 'campaigns': ['123:5555'], 'default_for_accounts': [123], 'acknowledge_warnings': True, 'user_max_bid': {'micros': 8340000, 'currency': 'AED'}}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "unchanged": [
      {
        "performance_group_id": "1245",
        "name": "tucan lorem",
        "enabled": true,
        "goals": [
          {
            "goal_type": "CLICKS-PER-DAY",
            "goal_value": 1.41,
            "goal_currency": "AED"
          }
        ],
        "campaigns": [
          "123:5555"
        ],
        "default_for_accounts": [
          123
        ],
        "acknowledge_warnings": true,
        "user_max_bid": {
          "micros": 8340000,
          "currency": "AED"
        }
      }
    ],
    "unknown": [
      {
        "performance_group_id": "1245",
        "name": "tucan lorem",
        "enabled": true,
        "goals": [
          {
            "goal_type": "CLICKS-PER-DAY",
            "goal_value": 1.41,
            "goal_currency": "AED"
          }
        ],
        "campaigns": [
          "123:5555"
        ],
        "default_for_accounts": [
          123
        ],
        "acknowledge_warnings": true,
        "user_max_bid": {
          "micros": 8340000,
          "currency": "AED"
        }
      }
    ],
    "updated": [
      {
        "performance_group_id": "1245",
        "name": "tucan lorem",
        "enabled": true,
        "goals": [
          {
            "goal_type": "CLICKS-PER-DAY",
            "goal_value": 1.41,
            "goal_currency": "AED"
          }
        ],
        "campaigns": [
          "123:5555"
        ],
        "default_for_accounts": [
          123
        ],
        "acknowledge_warnings": true,
        "user_max_bid": {
          "micros": 8340000,
          "currency": "AED"
        }
      }
    ]
  },
  "meta": {}
}

PerformanceGroupSuggestions

GET

GET /v3/customers/(customer_id: int)/performance-groups-suggestions

Gives out suggestions for a prospective performance group.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_adspert_campaign_id required	[ CompositeID ]	Only return results matching given adspert_campaign_id values. Min items: 1

Response Data (single object, json or csv or xlsx)

Name	Type	Description
user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.

Example

http

GET /v3/customers/7027038674/performance-groups-suggestions?exclude=elit.amet&filter_adspert_campaign_id=123%3A5555 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/performance-groups-suggestions?exclude=elit.amet&filter_adspert_campaign_id=123%3A5555' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/performance-groups-suggestions?exclude=elit.amet&filter_adspert_campaign_id=123%3A5555' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/performance-groups-suggestions?exclude=elit.amet&filter_adspert_campaign_id=123%3A5555', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "user_max_bid": {
      "micros": 8340000,
      "currency": "AED"
    }
  },
  "meta": {}
}

POST

POST /v3/customers/(customer_id: int)/performance-groups-suggestions

Gives out suggestions for a prospective performance group.

Note - This method supports POST requests, which serve the same purpose as GET requests. The addition of POST support is necessary to accommodate potentially large query parameters.

Auth mode:

api-token

Access level:

user

Request Data (single object, json)

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_adspert_campaign_id required	[ CompositeID ]	Only return results matching given adspert_campaign_id values. Min items: 1

Response Data (single object, json or csv or xlsx)

Name	Type	Description
user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.

Example

http

POST /v3/customers/7027038674/performance-groups-suggestions HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

{
  "include": [
    "ipsum.amet"
  ],
  "exclude": [
    "elit.amet"
  ],
  "filter_adspert_campaign_id": [
    "123:5555"
  ]
}

curl

curl -i -X POST https://api.adspert.net/v3/customers/7027038674/performance-groups-suggestions -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '{"exclude": ["elit.amet"], "filter_adspert_campaign_id": ["123:5555"], "include": ["ipsum.amet"]}'

httpie

echo '{
  "exclude": [
    "elit.amet"
  ],
  "filter_adspert_campaign_id": [
    "123:5555"
  ],
  "include": [
    "ipsum.amet"
  ]
}' | http POST https://api.adspert.net/v3/customers/7027038674/performance-groups-suggestions Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.post('https://api.adspert.net/v3/customers/7027038674/performance-groups-suggestions', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json={'exclude': ['elit.amet'], 'filter_adspert_campaign_id': ['123:5555'], 'include': ['ipsum.amet']})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "user_max_bid": {
      "micros": 8340000,
      "currency": "AED"
    }
  },
  "meta": {}
}

PerformanceGroupResource

GET

GET /v3/customers/(customer_id: int)/performance-groups/(performance_group_id: int)

Retrieve a single performance group.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
performance_group_id	Integer	Unique ID of the performance group
name	String	Unique name of the performance group.
optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
enabled	Boolean
created_at	DateTime
goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
campaigns	[ CompositeID ]	List of campaigns that belong to the performance group. Each item in the list is a composite id: {adspert_id}:{campaign_id}.
warnings	[ Object ]
⤷ type	PerformanceGroupWarningType	Type of the warning
⤷ priority	PerformanceGroupWarningPriority	Priority of the warning
⤷ adspert_account_id	Integer	Adspert internal ID of the advertising account
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id	LargeInteger
⤷ created_at	DateTime
⤷ acknowledged_at	DateTime
warning_status	PerformanceGroupWarningStatus	Status that summarizes all warnings associated with this performance group.
default_for_accounts	[ Integer ]	List of accounts that use this performance group as a default for newly added campaigns. Each item in the list is an adspert_account_id.
user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.

Example

http

GET /v3/customers/7027038674/performance-groups/6668648308?exclude=elit.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/performance-groups/6668648308?exclude=elit.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/performance-groups/6668648308?exclude=elit.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/performance-groups/6668648308?exclude=elit.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "performance_group_id": "1245",
    "name": "tucan lorem",
    "optimization_type": "CLICK",
    "enabled": true,
    "created_at": "2018-10-21T16:45:23+02:00",
    "goals": [
      {
        "goal_type": "CLICKS-PER-DAY",
        "goal_value": 1.41,
        "goal_currency": "AED",
        "goal_micros": 6300000,
        "goal_ratio": 8.77
      }
    ],
    "goal_types": [
      "CLICKS-PER-DAY"
    ],
    "campaigns": [
      "123:5555"
    ],
    "warnings": [
      {
        "type": "ACCOUNT-API-ACCESS-NONE",
        "priority": "HIGH",
        "adspert_account_id": 123,
        "adspert_campaign_id": "123:5555",
        "campaign_id": "5555",
        "created_at": "2018-10-21T16:45:23+02:00",
        "acknowledged_at": "2018-10-21T16:45:23+02:00"
      }
    ],
    "warning_status": "ACKNOWLEDGED",
    "default_for_accounts": [
      123
    ],
    "user_max_bid": {
      "micros": 8340000,
      "currency": "AED"
    }
  },
  "meta": {}
}

DELETE

DELETE /v3/customers/(customer_id: int)/performance-groups/(performance_group_id: int)

Delete a performance group.

Responds with a 409 (Conflict) if accounts of this customer are currently moved to another customer. During that time customer-level setting changes are not allowed.

Auth mode:

api-token

Access level:

user

Example

http

DELETE /v3/customers/7027038674/performance-groups/6668648308 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X DELETE https://api.adspert.net/v3/customers/7027038674/performance-groups/6668648308 -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http DELETE https://api.adspert.net/v3/customers/7027038674/performance-groups/6668648308 Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.delete('https://api.adspert.net/v3/customers/7027038674/performance-groups/6668648308', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

PerformanceGroupSnapshotPerformanceCollection

GET

GET /v3/customers/(customer_id: int)/performance-groups/(performance_group_id: int)/snapshot-performance

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where date is on or after this date.
filter_date_le required	Date	Only return results where date is on or before this date.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
sort_click_through_rate	SortDirective	Sort results by click_through_rate.
sort_clicks	SortDirective	Sort results by clicks.
sort_conversion_rate	SortDirective	Sort results by conversion_rate.
sort_conversion_rate_adjusted	SortDirective	Sort results by conversion_rate_adjusted.
sort_conversions	SortDirective	Sort results by conversions.
sort_conversions_adjusted	SortDirective	Sort results by conversions_adjusted.
sort_conversions_for_revenue	SortDirective	Sort results by conversions_for_revenue.
sort_conversions_for_revenue_adjusted	SortDirective	Sort results by conversions_for_revenue_adjusted.
sort_cost	SortDirective	Sort results by cost.
sort_cost_for_click	SortDirective	Sort results by cost_for_click.
sort_cost_for_profit	SortDirective	Sort results by cost_for_profit.
sort_cost_for_revenue	SortDirective	Sort results by cost_for_revenue.
sort_cost_optimization_type_click	SortDirective	Sort results by cost_optimization_type_click.
sort_cost_optimization_type_profit	SortDirective	Sort results by cost_optimization_type_profit.
sort_cost_optimization_type_revenue	SortDirective	Sort results by cost_optimization_type_revenue.
sort_cost_per_click	SortDirective	Sort results by cost_per_click.
sort_cost_per_conversion	SortDirective	Sort results by cost_per_conversion.
sort_cost_per_conversion_adjusted	SortDirective	Sort results by cost_per_conversion_adjusted.
sort_cost_revenue_ratio	SortDirective	Sort results by cost_revenue_ratio.
sort_cost_revenue_ratio_adjusted	SortDirective	Sort results by cost_revenue_ratio_adjusted.
sort_date	SortDirective	Sort results by date.
sort_enabled	SortDirective	Sort results by enabled.
sort_impressions	SortDirective	Sort results by impressions.
sort_profit	SortDirective	Sort results by profit.
sort_profit_adjusted	SortDirective	Sort results by profit_adjusted.
sort_profit_gross	SortDirective	Sort results by profit_gross.
sort_profit_gross_adjusted	SortDirective	Sort results by profit_gross_adjusted.
sort_profit_net	SortDirective	Sort results by profit_net.
sort_profit_net_adjusted	SortDirective	Sort results by profit_net_adjusted.
sort_return_on_ad_spend	SortDirective	Sort results by return_on_ad_spend.
sort_return_on_ad_spend_adjusted	SortDirective	Sort results by return_on_ad_spend_adjusted.
sort_return_on_investment	SortDirective	Sort results by return_on_investment.
sort_return_on_investment_adjusted	SortDirective	Sort results by return_on_investment_adjusted.
sort_revenue	SortDirective	Sort results by revenue.
sort_revenue_adjusted	SortDirective	Sort results by revenue_adjusted.
sort_revenue_per_conversion	SortDirective	Sort results by revenue_per_conversion.
sort_revenue_per_conversion_adjusted	SortDirective	Sort results by revenue_per_conversion_adjusted.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1
currency required	Currency

Response Data (object list, json or csv or xlsx)

Name	Type	Description
date	Date
enabled	Boolean
goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
impressions	Integer	Number of impressions
clicks	Integer	Number of clicks
conversions	Float	Number of conversions. Always 0 for click optimized campaigns.
conversions_adjusted	Float	Number of conversions adjusted for conversion delay. Always 0 for click optimized campaigns.
conversions_for_revenue	Float	Number of conversions for campaigns that support revenues. Always 0 for campaigns that don’t support revenue.
conversions_for_revenue_adjusted	Float	Number of conversions for campaigns that support revenues adjusted for conversion delay. Always 0 for campaigns that don’t support revenue.
profit	Micros	Profit. Always 0 for click and revenue optimized campaigns. DEPRECATED: Use profit_gross instead.
profit_adjusted	Micros	Profit adjusted for conversion delay. Always 0 for click and revenue optimized campaigns. DEPRECATED: Use profit_gross_adjusted instead.
profit_gross	Micros	Gross profit. Always 0 for click and revenue optimized campaigns.
profit_gross_adjusted	Micros	Gross profit adjusted for conversion delay. Always 0 for click and revenue optimized campaigns.
profit_net	Micros	Net profit. profit_gross - cost_for_profit Always 0 for click and revenue optimized campaigns.
profit_net_adjusted	Micros	Net profit adjusted for conversion delay. profit_gross_adjusted - cost_for_profit Always 0 for click and revenue optimized campaigns.
revenue	Micros	Revenue/sales. Always 0 for click and profit optimized campaigns.
revenue_adjusted	Micros	Revenue/sales adjusted for conversion delay. Always 0 for click and profit optimized campaigns.
cost	Micros	Total ad spend / cost
cost_optimization_type_click	Micros	Ad spend / cost from click optimized campaigns. Always 0 for revenue and profit optimized campaigns. DEPRECATED: Use cost_for_click instead.
cost_optimization_type_profit	Micros	Ad spend / cost from profit optimized campaigns. Always 0 for click and revenue optimized campaigns. DEPRECATED: Use cost_for_profit instead.
cost_optimization_type_revenue	Micros	Ad spend / cost from revenue optimized campaigns. Always 0 for click and profit optimized campaigns. DEPRECATED: Use cost_for_revenue instead.
cost_for_profit	Micros	Ad spend from campaigns that support profit. Always 0 for campaigns that don’t support profit.
cost_for_revenue	Micros	Ad spend from campaigns that support revenue. Always 0 for campaigns that don’t support revenue.
cost_for_click	Micros	Ad spend / cost from click optimized campaigns. Always 0 for revenue and profit optimized campaigns.
cost_per_click	Micros	Effective CPC. cost / clicks NULL if number of clicks is 0.
cost_per_conversion	Micros	Cost per conversion. Only cost for profit and revenue optimized campaigns is included. (cost - cost_for_click) / conversions NULL if number of conversions is 0.
cost_per_conversion_adjusted	Micros	Cost per conversion, adjusted for conversion delay. Only cost for profit and revenue optimized campaigns is included. (cost - cost_for_click) / conversions_adjusted NULL if number of conversions_adjusted is 0.
conversion_rate	Float	Conversion rate. conversions / clicks NULL if number of clicks is 0.
conversion_rate_adjusted	Float	Conversion rate, adjusted for conversion delay. conversions_adjusted / clicks NULL if number of clicks is 0.
click_through_rate	Float	Clickthrough rate (CTR). clicks / impressions NULL if number of impressions is 0.
return_on_investment	Float	Return on investment (ROI). Only cost for profit optimized campaigns is included. profit_gross / cost_for_profit NULL if cost_for_profit is 0.
return_on_investment_adjusted	Float	Return on investment (ROI), adjusted for conversion delay. Only cost for profit optimized campaigns is included. profit_gross_adjusted / cost_for_profit NULL if cost_for_profit is 0.
return_on_ad_spend	Float	Return on ad spend (ROAS). Only cost for revenue optimized campaigns is included. revenue / cost_for_revenue NULL if cost_for_revenue is 0.
return_on_ad_spend_adjusted	Float	Return on ad spend (ROAS), adjusted for conversion delay. Only cost for revenue optimized campaigns is included. revenue_adjusted / cost_for_revenue NULL if cost_for_revenue is 0.
cost_revenue_ratio	Float	Cost Revenue Ratio (CRR). Also called Advertising Cost of Sale (ACoS). Only cost for revenue optimized campaigns is included. cost_for_revenue / revenue NULL if revenue is 0.
cost_revenue_ratio_adjusted	Float	Cost Revenue Ratio (CRR), adjusted for conversion delay. Also called Advertising Cost of Sale (ACoS). Only cost for revenue optimized campaigns is included. cost_for_revenue / revenue_adjusted NULL if cost_for_revenue is 0.
revenue_per_conversion	Micros	Revenue per conversions. Only revenue and conversions for revenue supporting campaigns are included. revenue / conversions_for_revenue NULL if campaign doesn’t support revenue.
revenue_per_conversion_adjusted	Micros	Revenue per conversions adjusted for conversion delay. Only revenue and conversions for revenue supporting campaigns are included. revenue_adjusted / conversions_for_revenue_adjusted NULL if campaign doesn’t support revenue.

Example

http

GET /v3/customers/7027038674/performance-groups/6668648308/snapshot-performance?sort_return_on_investment=0&sort_conversions_for_revenue=-4&sort_impressions=1 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/performance-groups/6668648308/snapshot-performance?sort_return_on_investment=0&sort_conversions_for_revenue=-4&sort_impressions=1' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/performance-groups/6668648308/snapshot-performance?sort_return_on_investment=0&sort_conversions_for_revenue=-4&sort_impressions=1' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/performance-groups/6668648308/snapshot-performance?sort_return_on_investment=0&sort_conversions_for_revenue=-4&sort_impressions=1', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "date": "2018-10-21",
      "enabled": true,
      "goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "impressions": 2157218327,
      "clicks": 5857268080,
      "conversions": 3.92,
      "conversions_adjusted": 18.15,
      "conversions_for_revenue": 4.57,
      "conversions_for_revenue_adjusted": 4.9,
      "profit": 9510000,
      "profit_adjusted": 2710000,
      "profit_gross": 6420000,
      "profit_gross_adjusted": 9200000,
      "profit_net": 30000,
      "profit_net_adjusted": 3540000,
      "revenue": 360000,
      "revenue_adjusted": 9120000,
      "cost": 4540000,
      "cost_optimization_type_click": 7130000,
      "cost_optimization_type_profit": 8820000,
      "cost_optimization_type_revenue": 820000,
      "cost_for_profit": 800000,
      "cost_for_revenue": 6910000,
      "cost_for_click": 6810000,
      "cost_per_click": 7300000,
      "cost_per_conversion": 7570000,
      "cost_per_conversion_adjusted": 340000,
      "conversion_rate": 0.86,
      "conversion_rate_adjusted": 4.8,
      "click_through_rate": 7.58,
      "return_on_investment": 3.28,
      "return_on_investment_adjusted": 1.3,
      "return_on_ad_spend": 2.29,
      "return_on_ad_spend_adjusted": 8.05,
      "cost_revenue_ratio": 16.41,
      "cost_revenue_ratio_adjusted": 10.14,
      "revenue_per_conversion": 7070000,
      "revenue_per_conversion_adjusted": 4550000
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "date": 1
      }
    }
  }
}

AmazonPortfolioResource

GET

GET /v3/customers/(customer_id: int)/portfolios/(adspert_portfolio_id: str)

Retrieve a single portfolio.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
adspert_account_id	Integer	Adspert internal ID of the advertising account
account_id	String	Ad platform specific ID of an advertising account.
account_name	String
account_platform	AdPlatform	The account’s advertising platform.
account_optimize	Boolean	If optimization by Adspert is enabled for this account.
account_tags_user	[ String ]
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
portfolio_id	LargeInteger
portfolio_name	String

Example

http

GET /v3/customers/7027038674/portfolios/ID-1234?include=ipsum.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/portfolios/ID-1234?include=ipsum.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/portfolios/ID-1234?include=ipsum.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/portfolios/ID-1234?include=ipsum.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "adspert_account_id": 123,
    "account_id": "amet lorem",
    "account_name": "vehicula ipsum",
    "account_platform": "AMAZON",
    "account_optimize": true,
    "account_tags_user": [
      "vehicula amet"
    ],
    "account_is_demo": true,
    "adspert_portfolio_id": "123:9999",
    "portfolio_id": "9999",
    "portfolio_name": "ipsum pariatur"
  },
  "meta": {}
}

AmazonPortfolioCollection

GET

GET /v3/customers/(customer_id: int)/portfolios

Retrieve a list of portfolios.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_portfolio_name	[ String ]	Only return results matching given portfolio_name values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_portfolio_id	String	Only return results where portfolio_id matches the given string.
search_portfolio_name	String	Only return results where portfolio_name matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_is_demo	SortDirective	Sort results by account_is_demo.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_optimize	SortDirective	Sort results by account_optimize.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_portfolio_id	SortDirective	Sort results by portfolio_id.
sort_portfolio_name	SortDirective	Sort results by portfolio_name.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_id searchable	String	Ad platform specific ID of an advertising account.
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
account_optimize	Boolean	If optimization by Adspert is enabled for this account.
account_tags_user searchable	[ String ]
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
portfolio_id searchable	LargeInteger
portfolio_name searchable	String

Example

http

GET /v3/customers/7027038674/portfolios?search_account_id=elit+dolor&filter_account_tags_user=vehicula+amet&filter_adspert_portfolio_id=123%3A23 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/portfolios?search_account_id=elit+dolor&filter_account_tags_user=vehicula+amet&filter_adspert_portfolio_id=123%3A23' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/portfolios?search_account_id=elit+dolor&filter_account_tags_user=vehicula+amet&filter_adspert_portfolio_id=123%3A23' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/portfolios?search_account_id=elit+dolor&filter_account_tags_user=vehicula+amet&filter_adspert_portfolio_id=123%3A23', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "account_optimize": true,
      "account_tags_user": [
        "vehicula amet"
      ],
      "account_is_demo": true,
      "adspert_portfolio_id": "123:9999",
      "portfolio_id": "9999",
      "portfolio_name": "ipsum pariatur"
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "adspert_account_id": 1
      }
    }
  }
}

CampaignResource

GET

GET /v3/customers/(customer_id: int)/campaigns/(adspert_campaign_id: str)

Retrieve a single campaign.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
adspert_account_id	Integer	Adspert internal ID of the advertising account
account_id	String	Ad platform specific ID of an advertising account.
account_name	String
account_platform	AdPlatform	The account’s advertising platform.
account_optimize	Boolean	If optimization by Adspert is enabled for this account.
account_tags_user	[ String ]
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
account_currency	String
performance_group_id	Integer	Unique ID of the performance group
performance_group_name	String	Unique name of the performance group.
performance_group_enabled	Boolean
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id	LargeInteger
amz_portfolio_name	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id	LargeInteger
campaign_name	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_optimize	Boolean
campaign_status	CampaignStatus
campaign_labels	[ String ]
campaign_optimization_type	OptimizationType
campaign_optimization_support	CampaignOptimizationSupport
campaign_amz_targeting_type	AmzTargetingType	Amazon campaign targeting type.
campaign_conversion_value	Micros	Conversion value in micros
campaign_conversion_value_factor	Float	Conversion value factor
campaign_conversion_value_source	ConversionValueSource	Source of the conversion value e.g., platform, manual and product
campaign_conversion_value_type	ConversionValueType	Type of the conversion value e.g., revenue and profit
campaign_user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.
account_conversion_value_source	ConversionValueSource	Source of the conversion value e.g., platform, manual and product
account_conversion_value_type	ConversionValueType	Type of the conversion value e.g., revenue and profit
effective_conversion_value_source	ConversionValueSource	Source of the conversion value e.g., platform, manual and product
effective_conversion_value_type	ConversionValueType	Type of the conversion value e.g., revenue and profit
account_click_optimization	Boolean	If the account is set for click optimization

Example

http

GET /v3/customers/7027038674/campaigns/ID-1234?include=ipsum.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/campaigns/ID-1234?include=ipsum.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/campaigns/ID-1234?include=ipsum.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/campaigns/ID-1234?include=ipsum.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "adspert_account_id": 123,
    "account_id": "amet lorem",
    "account_name": "vehicula ipsum",
    "account_platform": "AMAZON",
    "account_optimize": true,
    "account_tags_user": [
      "vehicula amet"
    ],
    "account_is_demo": true,
    "account_currency": "ipsum adlora",
    "performance_group_id": "1245",
    "performance_group_name": "dolor sit",
    "performance_group_enabled": true,
    "performance_group_optimization_type": "CLICK",
    "performance_group_goals": [
      {
        "goal_type": "CLICKS-PER-DAY",
        "goal_value": 1.41,
        "goal_currency": "AED",
        "goal_micros": 6300000,
        "goal_ratio": 8.77
      }
    ],
    "performance_group_goal_types": [
      "CLICKS-PER-DAY"
    ],
    "adspert_portfolio_id": "123:9999",
    "amz_portfolio_id": "9999",
    "amz_portfolio_name": "elit adlora",
    "adspert_campaign_id": "123:5555",
    "campaign_id": "5555",
    "campaign_name": "sit ipsum",
    "campaign_type": "AMAZON-SPONSORED-BRANDS",
    "campaign_eby_marketplace_id": "amet pariatur",
    "campaign_optimize": true,
    "campaign_status": "ACTIVE",
    "campaign_labels": [
      "ipsum dolor"
    ],
    "campaign_optimization_type": "CLICK",
    "campaign_optimization_support": "SUPPORTED",
    "campaign_amz_targeting_type": "AUTO",
    "campaign_conversion_value": 4540000,
    "campaign_conversion_value_factor": 4.36,
    "campaign_conversion_value_source": "MANUAL",
    "campaign_conversion_value_type": "PROFIT",
    "campaign_user_max_bid": {
      "micros": 8340000,
      "currency": "AED"
    },
    "account_conversion_value_source": "MANUAL",
    "account_conversion_value_type": "PROFIT",
    "effective_conversion_value_source": "MANUAL",
    "effective_conversion_value_type": "PROFIT",
    "account_click_optimization": true
  },
  "meta": {}
}

CampaignCollection

GET

GET /v3/customers/(customer_id: int)/campaigns

Retrieve a list of campaigns.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_account_click_optimization	[ Boolean ]	Only return results matching given account_click_optimization values.
filter_account_conversion_value_source	[ ConversionValueSource ]	Only return results matching given account_conversion_value_source values.
filter_account_conversion_value_type	[ ConversionValueType ]	Only return results matching given account_conversion_value_type values.
filter_account_currency	[ String ]	Only return results matching given account_currency values.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_campaign_amz_targeting_type	[ AmzTargetingType ]	Only return results matching given campaign_amz_targeting_type values.
filter_campaign_conversion_value	[ Micros ]	Only return results matching given campaign_conversion_value values. Min value: 1000
filter_campaign_conversion_value_factor	[ Float ]	Only return results matching given campaign_conversion_value_factor values.
filter_campaign_conversion_value_factor_set	[ Boolean ]	Only return results matching given campaign_conversion_value_factor_set values.
filter_campaign_conversion_value_set	[ Boolean ]	Only return results matching given campaign_conversion_value_set values.
filter_campaign_conversion_value_source	[ ConversionValueSource ]	Only return results matching given campaign_conversion_value_source values.
filter_campaign_conversion_value_type	[ ConversionValueType ]	Only return results matching given campaign_conversion_value_type values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_campaign_user_max_bid_set	[ Boolean ]	Only return results matching given campaign_user_max_bid_set values.
filter_effective_conversion_value_source	[ ConversionValueSource ]	Only return results matching given effective_conversion_value_source values.
filter_effective_conversion_value_type	[ ConversionValueType ]	Only return results matching given effective_conversion_value_type values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
sort_account_click_optimization	SortDirective	Sort results by account_click_optimization.
sort_account_conversion_value_source	SortDirective	Sort results by account_conversion_value_source.
sort_account_conversion_value_type	SortDirective	Sort results by account_conversion_value_type.
sort_account_currency	SortDirective	Sort results by account_currency.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_is_demo	SortDirective	Sort results by account_is_demo.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_optimize	SortDirective	Sort results by account_optimize.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_campaign_amz_targeting_type	SortDirective	Sort results by campaign_amz_targeting_type.
sort_campaign_conversion_value	SortDirective	Sort results by campaign_conversion_value.
sort_campaign_conversion_value_factor	SortDirective	Sort results by campaign_conversion_value_factor.
sort_campaign_conversion_value_source	SortDirective	Sort results by campaign_conversion_value_source.
sort_campaign_conversion_value_type	SortDirective	Sort results by campaign_conversion_value_type.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_support	SortDirective	Sort results by campaign_optimization_support.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_status	SortDirective	Sort results by campaign_status.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_effective_conversion_value_source	SortDirective	Sort results by effective_conversion_value_source.
sort_effective_conversion_value_type	SortDirective	Sort results by effective_conversion_value_type.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_id searchable	String	Ad platform specific ID of an advertising account.
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
account_optimize	Boolean	If optimization by Adspert is enabled for this account.
account_tags_user searchable	[ String ]
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
account_currency	String
performance_group_id searchable	Integer	Unique ID of the performance group
performance_group_name searchable	String	Unique name of the performance group.
performance_group_enabled	Boolean
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger
amz_portfolio_name searchable	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger
campaign_name searchable	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_optimize	Boolean
campaign_status	CampaignStatus
campaign_labels searchable	[ String ]
campaign_optimization_type	OptimizationType
campaign_optimization_support	CampaignOptimizationSupport
campaign_amz_targeting_type	AmzTargetingType	Amazon campaign targeting type.
campaign_conversion_value	Micros	Conversion value in micros
campaign_conversion_value_factor	Float	Conversion value factor
campaign_conversion_value_source	ConversionValueSource	Source of the conversion value e.g., platform, manual and product
campaign_conversion_value_type	ConversionValueType	Type of the conversion value e.g., revenue and profit
campaign_user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.
account_conversion_value_source	ConversionValueSource	Source of the conversion value e.g., platform, manual and product
account_conversion_value_type	ConversionValueType	Type of the conversion value e.g., revenue and profit
effective_conversion_value_source	ConversionValueSource	Source of the conversion value e.g., platform, manual and product
effective_conversion_value_type	ConversionValueType	Type of the conversion value e.g., revenue and profit
account_click_optimization	Boolean	If the account is set for click optimization

Example

http

GET /v3/customers/7027038674/campaigns?offset=0&sort_account_is_demo=-6&sort_campaign_eby_marketplace_id=3 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/campaigns?offset=0&sort_account_is_demo=-6&sort_campaign_eby_marketplace_id=3' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/campaigns?offset=0&sort_account_is_demo=-6&sort_campaign_eby_marketplace_id=3' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/campaigns?offset=0&sort_account_is_demo=-6&sort_campaign_eby_marketplace_id=3', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "account_optimize": true,
      "account_tags_user": [
        "vehicula amet"
      ],
      "account_is_demo": true,
      "account_currency": "ipsum adlora",
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_enabled": true,
      "performance_group_optimization_type": "CLICK",
      "performance_group_goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "campaign_eby_marketplace_id": "amet pariatur",
      "campaign_optimize": true,
      "campaign_status": "ACTIVE",
      "campaign_labels": [
        "ipsum dolor"
      ],
      "campaign_optimization_type": "CLICK",
      "campaign_optimization_support": "SUPPORTED",
      "campaign_amz_targeting_type": "AUTO",
      "campaign_conversion_value": 4540000,
      "campaign_conversion_value_factor": 4.36,
      "campaign_conversion_value_source": "MANUAL",
      "campaign_conversion_value_type": "PROFIT",
      "campaign_user_max_bid": {
        "micros": 8340000,
        "currency": "AED"
      },
      "account_conversion_value_source": "MANUAL",
      "account_conversion_value_type": "PROFIT",
      "effective_conversion_value_source": "MANUAL",
      "effective_conversion_value_type": "PROFIT",
      "account_click_optimization": true
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "adspert_account_id": 1
      }
    }
  }
}

PATCH

PATCH /v3/customers/(customer_id: int)/campaigns

Update a collection of campaigns.

Responds with a 409 (Conflict) if accounts of this customer are currently moved to another customer. During that time customer-level setting changes are not allowed.

Auth mode:

api-token

Access level:

user

Request Data (object list, json)

Name	Type	Description
adspert_campaign_id required	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
conversion_value	Micros	Conversion value in micros Min value: 1000
conversion_value_factor	Float	Conversion value factor
conversion_value_source	ConversionValueSource	Source of the conversion value e.g., platform, manual and product
conversion_value_type	ConversionValueType	Type of the conversion value e.g., revenue and profit
user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros required	Micros	Monetary value in micros. Min value: 1000
⤷ currency required	Currency	Currency of the monetary value.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
unchanged	[ Object ]	List of objects which had no effective change.
⤷ adspert_campaign_id	CompositeID	See request data description.
⤷ conversion_value	Micros	See request data description.
⤷ conversion_value_factor	Float	See request data description.
⤷ conversion_value_source	ConversionValueSource	See request data description.
⤷ conversion_value_type	ConversionValueType	See request data description.
⤷ user_max_bid	Object	See request data description.
⤷ micros	Micros	See request data description.
⤷ currency	Currency	See request data description.
unknown	[ Object ]	List of objects which could not be found.
⤷ adspert_campaign_id	CompositeID	See request data description.
⤷ conversion_value	Micros	See request data description.
⤷ conversion_value_factor	Float	See request data description.
⤷ conversion_value_source	ConversionValueSource	See request data description.
⤷ conversion_value_type	ConversionValueType	See request data description.
⤷ user_max_bid	Object	See request data description.
⤷ micros	Micros	See request data description.
⤷ currency	Currency	See request data description.
updated	[ Object ]	List of objects which have been updated.
⤷ adspert_campaign_id	CompositeID	See request data description.
⤷ conversion_value	Micros	See request data description.
⤷ conversion_value_factor	Float	See request data description.
⤷ conversion_value_source	ConversionValueSource	See request data description.
⤷ conversion_value_type	ConversionValueType	See request data description.
⤷ user_max_bid	Object	See request data description.
⤷ micros	Micros	See request data description.
⤷ currency	Currency	See request data description.

Example

http

PATCH /v3/customers/7027038674/campaigns HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "adspert_campaign_id": "123:5555",
    "conversion_value": 150000,
    "conversion_value_factor": 1.09,
    "conversion_value_source": "MANUAL",
    "conversion_value_type": "PROFIT",
    "user_max_bid": {
      "micros": 8340000,
      "currency": "AED"
    }
  }
]

curl

curl -i -X PATCH https://api.adspert.net/v3/customers/7027038674/campaigns -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"adspert_campaign_id": "123:5555", "conversion_value": 150000, "conversion_value_factor": 1.09, "conversion_value_source": "MANUAL", "conversion_value_type": "PROFIT", "user_max_bid": {"micros": 8340000, "currency": "AED"}}]'

httpie

echo '[
  {
    "adspert_campaign_id": "123:5555",
    "conversion_value": 150000,
    "conversion_value_factor": 1.09,
    "conversion_value_source": "MANUAL",
    "conversion_value_type": "PROFIT",
    "user_max_bid": {
      "currency": "AED",
      "micros": 8340000
    }
  }
]' | http PATCH https://api.adspert.net/v3/customers/7027038674/campaigns Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.patch('https://api.adspert.net/v3/customers/7027038674/campaigns', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'adspert_campaign_id': '123:5555', 'conversion_value': 150000, 'conversion_value_factor': 1.09, 'conversion_value_source': 'MANUAL', 'conversion_value_type': 'PROFIT', 'user_max_bid': {'micros': 8340000, 'currency': 'AED'}}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "unchanged": [
      {
        "adspert_campaign_id": "123:5555",
        "conversion_value": 150000,
        "conversion_value_factor": 1.09,
        "conversion_value_source": "MANUAL",
        "conversion_value_type": "PROFIT",
        "user_max_bid": {
          "micros": 8340000,
          "currency": "AED"
        }
      }
    ],
    "unknown": [
      {
        "adspert_campaign_id": "123:5555",
        "conversion_value": 150000,
        "conversion_value_factor": 1.09,
        "conversion_value_source": "MANUAL",
        "conversion_value_type": "PROFIT",
        "user_max_bid": {
          "micros": 8340000,
          "currency": "AED"
        }
      }
    ],
    "updated": [
      {
        "adspert_campaign_id": "123:5555",
        "conversion_value": 150000,
        "conversion_value_factor": 1.09,
        "conversion_value_source": "MANUAL",
        "conversion_value_type": "PROFIT",
        "user_max_bid": {
          "micros": 8340000,
          "currency": "AED"
        }
      }
    ]
  },
  "meta": {}
}

AdgroupResource

GET

GET /v3/customers/(customer_id: int)/adgroups/(adspert_adgroup_id: str)

Retrieve a single ad group.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
adspert_account_id	Integer	Adspert internal ID of the advertising account
account_id	String	Ad platform specific ID of an advertising account.
account_name	String
account_platform	AdPlatform	The account’s advertising platform.
account_optimize	Boolean	If optimization by Adspert is enabled for this account.
account_tags_user	[ String ]
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
account_currency	String
performance_group_id	Integer	Unique ID of the performance group
performance_group_name	String	Unique name of the performance group.
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_enabled	Boolean
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id	LargeInteger
amz_portfolio_name	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id	LargeInteger
campaign_name	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_status	CampaignStatus
campaign_optimize	Boolean
campaign_optimization_support	CampaignOptimizationSupport
campaign_optimization_type	OptimizationType
campaign_amz_targeting_type	AmzTargetingType	Amazon campaign targeting type.
campaign_labels	[ String ]
adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
adgroup_id	LargeInteger
adgroup_name	String
adgroup_status	AdgroupStatus
adgroup_labels	[ String ]
adgroup_max_cpc	Micros
amz_product_ads_sync_source	Object	Details about the source AdGroup where the Product Ads are being synced from. This can only be populated for Amazon SP Manual AdGroups. NULL if the AdGroup isn’t yet being synced.
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_name	String
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_name	String
⤷ sync_mode	ApiEnumSyncMode	Mode of the product ad sync.
⤷ read_only	Boolean	Indicates if the target AdGroup can be modified.

Example

http

GET /v3/customers/7027038674/adgroups/ID-1234?exclude=elit.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/adgroups/ID-1234?exclude=elit.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/adgroups/ID-1234?exclude=elit.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/adgroups/ID-1234?exclude=elit.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "adspert_account_id": 123,
    "account_id": "amet lorem",
    "account_name": "vehicula ipsum",
    "account_platform": "AMAZON",
    "account_optimize": true,
    "account_tags_user": [
      "vehicula amet"
    ],
    "account_is_demo": true,
    "account_currency": "ipsum adlora",
    "performance_group_id": "1245",
    "performance_group_name": "dolor sit",
    "performance_group_optimization_type": "CLICK",
    "performance_group_enabled": true,
    "performance_group_goals": [
      {
        "goal_type": "CLICKS-PER-DAY",
        "goal_value": 1.41,
        "goal_currency": "AED",
        "goal_micros": 6300000,
        "goal_ratio": 8.77
      }
    ],
    "performance_group_goal_types": [
      "CLICKS-PER-DAY"
    ],
    "adspert_portfolio_id": "123:9999",
    "amz_portfolio_id": "9999",
    "amz_portfolio_name": "elit adlora",
    "adspert_campaign_id": "123:5555",
    "campaign_id": "5555",
    "campaign_name": "sit ipsum",
    "campaign_type": "AMAZON-SPONSORED-BRANDS",
    "campaign_eby_marketplace_id": "amet pariatur",
    "campaign_status": "ACTIVE",
    "campaign_optimize": true,
    "campaign_optimization_support": "SUPPORTED",
    "campaign_optimization_type": "CLICK",
    "campaign_amz_targeting_type": "AUTO",
    "campaign_labels": [
      "ipsum dolor"
    ],
    "adspert_adgroup_id": "123:777",
    "adgroup_id": "777",
    "adgroup_name": "tucan lorem",
    "adgroup_status": "ACTIVE",
    "adgroup_labels": [
      "elit ipsum"
    ],
    "adgroup_max_cpc": 3810000,
    "amz_product_ads_sync_source": {
      "adspert_campaign_id": "123:5555",
      "campaign_name": "sit ipsum",
      "adspert_adgroup_id": "123:777",
      "adgroup_name": "tucan lorem",
      "sync_mode": "ADD-MISSING",
      "read_only": true
    }
  },
  "meta": {}
}

AdgroupCollection

GET

GET /v3/customers/(customer_id: int)/adgroups

Retrieve a list of ad groups.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_account_currency	[ String ]	Only return results matching given account_currency values.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_adgroup_labels	[ String ]	Only return results matching given adgroup_labels values.
filter_adgroup_name	[ String ]	Only return results matching given adgroup_name values.
filter_adgroup_status	[ AdgroupStatus ]	Only return results matching given adgroup_status values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_adspert_adgroup_id	[ CompositeID ]	Only return results matching given adspert_adgroup_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_campaign_amz_targeting_type	[ AmzTargetingType ]	Only return results matching given campaign_amz_targeting_type values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_adgroup_id	String	Only return results where adgroup_id matches the given string.
search_adgroup_labels	String	Only return results where adgroup_labels matches the given string.
search_adgroup_name	String	Only return results where adgroup_name matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
sort_account_currency	SortDirective	Sort results by account_currency.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_is_demo	SortDirective	Sort results by account_is_demo.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_optimize	SortDirective	Sort results by account_optimize.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adgroup_id	SortDirective	Sort results by adgroup_id.
sort_adgroup_max_cpc	SortDirective	Sort results by adgroup_max_cpc.
sort_adgroup_name	SortDirective	Sort results by adgroup_name.
sort_adgroup_status	SortDirective	Sort results by adgroup_status.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_adspert_adgroup_id	SortDirective	Sort results by adspert_adgroup_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_campaign_amz_targeting_type	SortDirective	Sort results by campaign_amz_targeting_type.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_support	SortDirective	Sort results by campaign_optimization_support.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_status	SortDirective	Sort results by campaign_status.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_id searchable	String	Ad platform specific ID of an advertising account.
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
account_optimize	Boolean	If optimization by Adspert is enabled for this account.
account_tags_user searchable	[ String ]
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
account_currency	String
performance_group_id searchable	Integer	Unique ID of the performance group
performance_group_name searchable	String	Unique name of the performance group.
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_enabled	Boolean
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger
amz_portfolio_name searchable	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger
campaign_name searchable	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_status	CampaignStatus
campaign_optimize	Boolean
campaign_optimization_support	CampaignOptimizationSupport
campaign_optimization_type	OptimizationType
campaign_amz_targeting_type	AmzTargetingType	Amazon campaign targeting type.
campaign_labels searchable	[ String ]
adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
adgroup_id searchable	LargeInteger
adgroup_name searchable	String
adgroup_status	AdgroupStatus
adgroup_labels searchable	[ String ]
adgroup_max_cpc	Micros
amz_product_ads_sync_source	Object	Details about the source AdGroup where the Product Ads are being synced from. This can only be populated for Amazon SP Manual AdGroups. NULL if the AdGroup isn’t yet being synced.
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_name searchable	String
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_name searchable	String
⤷ sync_mode	ApiEnumSyncMode	Mode of the product ad sync.
⤷ read_only	Boolean	Indicates if the target AdGroup can be modified.

Example

http

GET /v3/customers/7027038674/adgroups?sort_adgroup_status=-6&search_term=vehicula+ipsum&sort_account_is_demo=-6 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/adgroups?sort_adgroup_status=-6&search_term=vehicula+ipsum&sort_account_is_demo=-6' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/adgroups?sort_adgroup_status=-6&search_term=vehicula+ipsum&sort_account_is_demo=-6' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/adgroups?sort_adgroup_status=-6&search_term=vehicula+ipsum&sort_account_is_demo=-6', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "account_optimize": true,
      "account_tags_user": [
        "vehicula amet"
      ],
      "account_is_demo": true,
      "account_currency": "ipsum adlora",
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_optimization_type": "CLICK",
      "performance_group_enabled": true,
      "performance_group_goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "campaign_eby_marketplace_id": "amet pariatur",
      "campaign_status": "ACTIVE",
      "campaign_optimize": true,
      "campaign_optimization_support": "SUPPORTED",
      "campaign_optimization_type": "CLICK",
      "campaign_amz_targeting_type": "AUTO",
      "campaign_labels": [
        "ipsum dolor"
      ],
      "adspert_adgroup_id": "123:777",
      "adgroup_id": "777",
      "adgroup_name": "tucan lorem",
      "adgroup_status": "ACTIVE",
      "adgroup_labels": [
        "elit ipsum"
      ],
      "adgroup_max_cpc": 3810000,
      "amz_product_ads_sync_source": {
        "adspert_campaign_id": "123:5555",
        "campaign_name": "sit ipsum",
        "adspert_adgroup_id": "123:777",
        "adgroup_name": "tucan lorem",
        "sync_mode": "ADD-MISSING",
        "read_only": true
      }
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "adspert_account_id": 1
      }
    }
  }
}

AccountAdgroupResource [DEPRECATED]

GET

GET /v3/accounts/(adspert_account_id: int)/adgroups/(adspert_adgroup_id: str)

Retrieve a single ad group.

DEPRECATED: Use customers/(customer_id: int)/adgroups/(adspert_adgroup_id: str).

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
performance_group_id	Integer	Unique ID of the performance group
performance_group_name	String	Unique name of the performance group.
performance_group_enabled	Boolean
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id	LargeInteger
amz_portfolio_name	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id	LargeInteger
campaign_name	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_status	CampaignStatus
campaign_optimize	Boolean
campaign_optimization_type	OptimizationType
campaign_labels	[ String ]
adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
adgroup_id	LargeInteger
adgroup_name	String
adgroup_status	AdgroupStatus
adgroup_labels	[ String ]
adgroup_max_cpc	Micros

Example

http

GET /v3/accounts/3420379091/adgroups/ID-1234?exclude=elit.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/accounts/3420379091/adgroups/ID-1234?exclude=elit.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/accounts/3420379091/adgroups/ID-1234?exclude=elit.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/accounts/3420379091/adgroups/ID-1234?exclude=elit.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "performance_group_id": "1245",
    "performance_group_name": "dolor sit",
    "performance_group_enabled": true,
    "performance_group_optimization_type": "CLICK",
    "performance_group_goals": [
      {
        "goal_type": "CLICKS-PER-DAY",
        "goal_value": 1.41,
        "goal_currency": "AED",
        "goal_micros": 6300000,
        "goal_ratio": 8.77
      }
    ],
    "performance_group_goal_types": [
      "CLICKS-PER-DAY"
    ],
    "adspert_portfolio_id": "123:9999",
    "amz_portfolio_id": "9999",
    "amz_portfolio_name": "elit adlora",
    "adspert_campaign_id": "123:5555",
    "campaign_id": "5555",
    "campaign_name": "sit ipsum",
    "campaign_type": "AMAZON-SPONSORED-BRANDS",
    "campaign_eby_marketplace_id": "amet pariatur",
    "campaign_status": "ACTIVE",
    "campaign_optimize": true,
    "campaign_optimization_type": "CLICK",
    "campaign_labels": [
      "ipsum dolor"
    ],
    "adspert_adgroup_id": "123:777",
    "adgroup_id": "777",
    "adgroup_name": "tucan lorem",
    "adgroup_status": "ACTIVE",
    "adgroup_labels": [
      "elit ipsum"
    ],
    "adgroup_max_cpc": 3810000
  },
  "meta": {}
}

AccountAdgroupCollection [DEPRECATED]

GET

GET /v3/accounts/(adspert_account_id: int)/adgroups

Retrieve a list of ad groups.

DEPRECATED: Use customers/(customer_id: int)/adgroups/.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_adgroup_labels	[ String ]	Only return results matching given adgroup_labels values.
filter_adgroup_name	[ String ]	Only return results matching given adgroup_name values.
filter_adgroup_status	[ AdgroupStatus ]	Only return results matching given adgroup_status values.
filter_adspert_adgroup_id	[ CompositeID ]	Only return results matching given adspert_adgroup_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_adgroup_id	String	Only return results where adgroup_id matches the given string.
search_adgroup_labels	String	Only return results where adgroup_labels matches the given string.
search_adgroup_name	String	Only return results where adgroup_name matches the given string.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
sort_adgroup_id	SortDirective	Sort results by adgroup_id.
sort_adgroup_max_cpc	SortDirective	Sort results by adgroup_max_cpc.
sort_adgroup_name	SortDirective	Sort results by adgroup_name.
sort_adgroup_status	SortDirective	Sort results by adgroup_status.
sort_adspert_adgroup_id	SortDirective	Sort results by adspert_adgroup_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_status	SortDirective	Sort results by campaign_status.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
performance_group_id searchable	Integer	Unique ID of the performance group
performance_group_name searchable	String	Unique name of the performance group.
performance_group_enabled	Boolean
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger
amz_portfolio_name searchable	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger
campaign_name searchable	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_status	CampaignStatus
campaign_optimize	Boolean
campaign_optimization_type	OptimizationType
campaign_labels searchable	[ String ]
adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
adgroup_id searchable	LargeInteger
adgroup_name searchable	String
adgroup_status	AdgroupStatus
adgroup_labels searchable	[ String ]
adgroup_max_cpc	Micros

Example

http

GET /v3/accounts/3420379091/adgroups?sort_adgroup_status=-6&filter_adspert_adgroup_id=123%3A13&search_campaign_name=lorem+tucan HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/accounts/3420379091/adgroups?sort_adgroup_status=-6&filter_adspert_adgroup_id=123%3A13&search_campaign_name=lorem+tucan' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/accounts/3420379091/adgroups?sort_adgroup_status=-6&filter_adspert_adgroup_id=123%3A13&search_campaign_name=lorem+tucan' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/accounts/3420379091/adgroups?sort_adgroup_status=-6&filter_adspert_adgroup_id=123%3A13&search_campaign_name=lorem+tucan', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_enabled": true,
      "performance_group_optimization_type": "CLICK",
      "performance_group_goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "campaign_eby_marketplace_id": "amet pariatur",
      "campaign_status": "ACTIVE",
      "campaign_optimize": true,
      "campaign_optimization_type": "CLICK",
      "campaign_labels": [
        "ipsum dolor"
      ],
      "adspert_adgroup_id": "123:777",
      "adgroup_id": "777",
      "adgroup_name": "tucan lorem",
      "adgroup_status": "ACTIVE",
      "adgroup_labels": [
        "elit ipsum"
      ],
      "adgroup_max_cpc": 3810000
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "performance_group_id": 1
      }
    }
  }
}

CriterionResource

GET

GET /v3/accounts/(adspert_account_id: int)/criteria/(adspert_criterion_id: str)

Retrieve a single criterion.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
performance_group_id	Integer	Unique ID of the performance group
performance_group_name	String	Unique name of the performance group.
performance_group_enabled	Boolean
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id	LargeInteger
amz_portfolio_name	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id	LargeInteger
campaign_name	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_status	CampaignStatus
campaign_optimize	Boolean
campaign_optimization_type	OptimizationType
campaign_labels	[ String ]
adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
adgroup_id	LargeInteger
adgroup_name	String
adgroup_status	AdgroupStatus
adgroup_labels	[ String ]
adspert_criterion_id	CompositeID	Adspert internal ID of the criterion. Composite ID specification: {adspert_account_id}:{adgroup_id}:{criterion_id}
criterion_id	LargeInteger
criterion_name	String
criterion_status	CriterionStatus
criterion_type	CriterionType
criterion_match_type	CriterionMatchType	Match type of Keyword criterion. NULL if criterion_type is not Keyword.
criterion_labels	[ String ]

Example

http

GET /v3/accounts/3420379091/criteria/ID-1234?exclude=elit.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/accounts/3420379091/criteria/ID-1234?exclude=elit.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/accounts/3420379091/criteria/ID-1234?exclude=elit.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/accounts/3420379091/criteria/ID-1234?exclude=elit.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "performance_group_id": "1245",
    "performance_group_name": "dolor sit",
    "performance_group_enabled": true,
    "performance_group_optimization_type": "CLICK",
    "performance_group_goals": [
      {
        "goal_type": "CLICKS-PER-DAY",
        "goal_value": 1.41,
        "goal_currency": "AED",
        "goal_micros": 6300000,
        "goal_ratio": 8.77
      }
    ],
    "performance_group_goal_types": [
      "CLICKS-PER-DAY"
    ],
    "adspert_portfolio_id": "123:9999",
    "amz_portfolio_id": "9999",
    "amz_portfolio_name": "elit adlora",
    "adspert_campaign_id": "123:5555",
    "campaign_id": "5555",
    "campaign_name": "sit ipsum",
    "campaign_type": "AMAZON-SPONSORED-BRANDS",
    "campaign_eby_marketplace_id": "amet pariatur",
    "campaign_status": "ACTIVE",
    "campaign_optimize": true,
    "campaign_optimization_type": "CLICK",
    "campaign_labels": [
      "ipsum dolor"
    ],
    "adspert_adgroup_id": "123:777",
    "adgroup_id": "777",
    "adgroup_name": "tucan lorem",
    "adgroup_status": "ACTIVE",
    "adgroup_labels": [
      "elit ipsum"
    ],
    "adspert_criterion_id": "123:777:66789",
    "criterion_id": "66789",
    "criterion_name": "dolor adlora",
    "criterion_status": "ACTIVE",
    "criterion_type": "AUDIENCE",
    "criterion_match_type": "BROAD",
    "criterion_labels": [
      "adlora dolor"
    ]
  },
  "meta": {}
}

CriterionCollection

GET

GET /v3/accounts/(adspert_account_id: int)/criteria

Retrieve a list of criteria.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_adgroup_labels	[ String ]	Only return results matching given adgroup_labels values.
filter_adgroup_name	[ String ]	Only return results matching given adgroup_name values.
filter_adgroup_status	[ AdgroupStatus ]	Only return results matching given adgroup_status values.
filter_adspert_adgroup_id	[ CompositeID ]	Only return results matching given adspert_adgroup_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_criterion_id	[ CompositeID ]	Only return results matching given adspert_criterion_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_criterion_labels	[ String ]	Only return results matching given criterion_labels values.
filter_criterion_match_type	[ CriterionMatchType ]	Only return results matching given criterion_match_type values.
filter_criterion_name	[ String ]	Only return results matching given criterion_name values.
filter_criterion_status	[ CriterionStatus ]	Only return results matching given criterion_status values.
filter_criterion_type	[ CriterionType ]	Only return results matching given criterion_type values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_adgroup_id	String	Only return results where adgroup_id matches the given string.
search_adgroup_labels	String	Only return results where adgroup_labels matches the given string.
search_adgroup_name	String	Only return results where adgroup_name matches the given string.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_criterion_id	String	Only return results where criterion_id matches the given string.
search_criterion_labels	String	Only return results where criterion_labels matches the given string.
search_criterion_name	String	Only return results where criterion_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
sort_adgroup_id	SortDirective	Sort results by adgroup_id.
sort_adgroup_name	SortDirective	Sort results by adgroup_name.
sort_adgroup_status	SortDirective	Sort results by adgroup_status.
sort_adspert_adgroup_id	SortDirective	Sort results by adspert_adgroup_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_criterion_id	SortDirective	Sort results by adspert_criterion_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_status	SortDirective	Sort results by campaign_status.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_criterion_id	SortDirective	Sort results by criterion_id.
sort_criterion_match_type	SortDirective	Sort results by criterion_match_type.
sort_criterion_name	SortDirective	Sort results by criterion_name.
sort_criterion_status	SortDirective	Sort results by criterion_status.
sort_criterion_type	SortDirective	Sort results by criterion_type.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
performance_group_id searchable	Integer	Unique ID of the performance group
performance_group_name searchable	String	Unique name of the performance group.
performance_group_enabled	Boolean
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger
amz_portfolio_name searchable	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger
campaign_name searchable	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_status	CampaignStatus
campaign_optimize	Boolean
campaign_optimization_type	OptimizationType
campaign_labels searchable	[ String ]
adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
adgroup_id searchable	LargeInteger
adgroup_name searchable	String
adgroup_status	AdgroupStatus
adgroup_labels searchable	[ String ]
adspert_criterion_id	CompositeID	Adspert internal ID of the criterion. Composite ID specification: {adspert_account_id}:{adgroup_id}:{criterion_id}
criterion_id searchable	LargeInteger
criterion_name searchable	String
criterion_status	CriterionStatus
criterion_type	CriterionType
criterion_match_type	CriterionMatchType	Match type of Keyword criterion. NULL if criterion_type is not Keyword.
criterion_labels searchable	[ String ]

Example

http

GET /v3/accounts/3420379091/criteria?search_criterion_labels=dolor+tucan&filter_adspert_criterion_id=123%3A95%3A84&filter_campaign_status=ACTIVE HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/accounts/3420379091/criteria?search_criterion_labels=dolor+tucan&filter_adspert_criterion_id=123%3A95%3A84&filter_campaign_status=ACTIVE' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/accounts/3420379091/criteria?search_criterion_labels=dolor+tucan&filter_adspert_criterion_id=123%3A95%3A84&filter_campaign_status=ACTIVE' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/accounts/3420379091/criteria?search_criterion_labels=dolor+tucan&filter_adspert_criterion_id=123%3A95%3A84&filter_campaign_status=ACTIVE', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_enabled": true,
      "performance_group_optimization_type": "CLICK",
      "performance_group_goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "campaign_eby_marketplace_id": "amet pariatur",
      "campaign_status": "ACTIVE",
      "campaign_optimize": true,
      "campaign_optimization_type": "CLICK",
      "campaign_labels": [
        "ipsum dolor"
      ],
      "adspert_adgroup_id": "123:777",
      "adgroup_id": "777",
      "adgroup_name": "tucan lorem",
      "adgroup_status": "ACTIVE",
      "adgroup_labels": [
        "elit ipsum"
      ],
      "adspert_criterion_id": "123:777:66789",
      "criterion_id": "66789",
      "criterion_name": "dolor adlora",
      "criterion_status": "ACTIVE",
      "criterion_type": "AUDIENCE",
      "criterion_match_type": "BROAD",
      "criterion_labels": [
        "adlora dolor"
      ]
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "performance_group_id": 1
      }
    }
  }
}

ProductResource

GET

GET /v3/accounts/(adspert_account_id: int)/products/(adspert_product_id: b32)

Retrieve a single product.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
adspert_product_id	String	Adspert’s unique product ID.
title	String	Product title.
image_url	String	Product image URL.
amz_asin	String	Amazon ASIN.
amz_sku	String	Amazon SKU.
ggl_offer_id	String	Google Offer ID.
eby_listing_id	String	eBay Listing ID.

Example

http

GET /v3/accounts/3420379091/products/JFCC2MJSGM2A====?include=ipsum.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/accounts/3420379091/products/JFCC2MJSGM2A====?include=ipsum.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/accounts/3420379091/products/JFCC2MJSGM2A====?include=ipsum.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/accounts/3420379091/products/JFCC2MJSGM2A====?include=ipsum.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "adspert_product_id": "B0100000000|000-000-001",
    "title": "Product XYZ",
    "image_url": "https://example.com/B0100000000.jpg",
    "amz_asin": "B0100000000",
    "amz_sku": "000-000-001",
    "ggl_offer_id": "12345678",
    "eby_listing_id": "12345678"
  },
  "meta": {}
}

ProductCollection

GET

GET /v3/accounts/(adspert_account_id: int)/products

Retrieve a list of products.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_adspert_product_id	[ String ]	Only return results matching given adspert_product_id values.
filter_amz_asin	[ String ]	Only return results matching given amz_asin values.
filter_amz_sku	[ String ]	Only return results matching given amz_sku values.
filter_eby_listing_id	[ String ]	Only return results matching given eby_listing_id values.
filter_ggl_offer_id	[ String ]	Only return results matching given ggl_offer_id values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_amz_asin	String	Only return results where amz_asin matches the given string.
search_amz_sku	String	Only return results where amz_sku matches the given string.
search_eby_listing_id	String	Only return results where eby_listing_id matches the given string.
search_ggl_offer_id	String	Only return results where ggl_offer_id matches the given string.
search_title	String	Only return results where title matches the given string.
sort_adspert_product_id	SortDirective	Sort results by adspert_product_id.
sort_amz_asin	SortDirective	Sort results by amz_asin.
sort_amz_sku	SortDirective	Sort results by amz_sku.
sort_eby_listing_id	SortDirective	Sort results by eby_listing_id.
sort_ggl_offer_id	SortDirective	Sort results by ggl_offer_id.
sort_image_url	SortDirective	Sort results by image_url.
sort_title	SortDirective	Sort results by title.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
adspert_product_id	String	Adspert’s unique product ID.
title searchable	String	Product title.
image_url	String	Product image URL.
amz_asin searchable	String	Amazon ASIN.
amz_sku searchable	String	Amazon SKU.
ggl_offer_id searchable	String	Google Offer ID.
eby_listing_id searchable	String	eBay Listing ID.

Example

http

GET /v3/accounts/3420379091/products?offset=0&sort_amz_sku=7&search_title=tucan+lorem HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/accounts/3420379091/products?offset=0&sort_amz_sku=7&search_title=tucan+lorem' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/accounts/3420379091/products?offset=0&sort_amz_sku=7&search_title=tucan+lorem' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/accounts/3420379091/products?offset=0&sort_amz_sku=7&search_title=tucan+lorem', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "adspert_product_id": "B0100000000|000-000-001",
      "title": "Product XYZ",
      "image_url": "https://example.com/B0100000000.jpg",
      "amz_asin": "B0100000000",
      "amz_sku": "000-000-001",
      "ggl_offer_id": "12345678",
      "eby_listing_id": "12345678"
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "adspert_product_id": 1
      }
    }
  }
}

LabelCollection

GET

GET /v3/preview/customers/(customer_id: int)/labels

Retrieve a list of labels.

Attention

This route is in preview stage and will change into a stable interface in the future. See also Preview Roadmap.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_label_name	String	Only return results where label_name matches the given string.
sort_label_name	SortDirective	Sort results by label_name.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1
label_level	LabelLevel	Default: ALL

Response Data (object list, json or csv or xlsx)

Name	Type	Description
label_name searchable	String

Example

http

GET /v3/preview/customers/7027038674/labels?search_fields=pariatur.adlora&search_term=vehicula+ipsum&search_label_name=elit+lorem HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/preview/customers/7027038674/labels?search_fields=pariatur.adlora&search_term=vehicula+ipsum&search_label_name=elit+lorem' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/preview/customers/7027038674/labels?search_fields=pariatur.adlora&search_term=vehicula+ipsum&search_label_name=elit+lorem' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/preview/customers/7027038674/labels?search_fields=pariatur.adlora&search_term=vehicula+ipsum&search_label_name=elit+lorem', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "label_name": "ipsum elit"
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "label_name": 1
      }
    }
  }
}

BudgetSuggestionCollection

GET

GET /v3/customers/(customer_id: int)/budget-suggestions

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_account_currency	[ ApiCurrency ]	Only return results matching given account_currency values.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_acos_30	[ Float ]	Only return results matching given acos_30 values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_id	[ Integer ]	Only return results matching given adspert_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_approved_account_currency	[ Micros ]	Only return results matching given approved_account_currency values. Min value: 1000
filter_approved_euros	[ Micros ]	Only return results matching given approved_euros values. Min value: 1000
filter_avg_cost_7	[ Integer ]	Only return results matching given avg_cost_7 values.
filter_avg_coverage_7	[ Float ]	Only return results matching given avg_coverage_7 values.
filter_budget_id	[ Integer ]	Only return results matching given budget_id values.
filter_budget_usage_7	[ Float ]	Only return results matching given budget_usage_7 values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_conversions_30	[ Integer ]	Only return results matching given conversions_30 values.
filter_current_account_currency	[ Micros ]	Only return results matching given current_account_currency values. Min value: 1000
filter_current_euros	[ Micros ]	Only return results matching given current_euros values. Min value: 1000
filter_est_optimal_spending	[ Float ]	Only return results matching given est_optimal_spending values.
filter_increase	[ Boolean ]	Only return results matching given increase values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
filter_state	[ BudgetSuggestionState ]	Only return results matching given state values.
filter_suggested_account_currency	[ Micros ]	Only return results matching given suggested_account_currency values. Min value: 1000
filter_suggested_at_ge	Date	Only return results where suggested_at is on or after this date.
filter_suggested_at_le	Date	Only return results where suggested_at is on or before this date.
filter_suggested_euros	[ Micros ]	Only return results matching given suggested_euros values. Min value: 1000
filter_suggestion_id	[ Integer ]	Only return results matching given suggestion_id values.
filter_updated_at_ge	Date	Only return results where updated_at is on or after this date.
filter_updated_at_le	Date	Only return results where updated_at is on or before this date.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
sort_account_currency	SortDirective	Sort results by account_currency.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_is_demo	SortDirective	Sort results by account_is_demo.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_optimize	SortDirective	Sort results by account_optimize.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_acos_30	SortDirective	Sort results by acos_30.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_id	SortDirective	Sort results by adspert_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_approved_account_currency	SortDirective	Sort results by approved_account_currency.
sort_approved_euros	SortDirective	Sort results by approved_euros.
sort_avg_cost_7	SortDirective	Sort results by avg_cost_7.
sort_avg_coverage_7	SortDirective	Sort results by avg_coverage_7.
sort_budget_id	SortDirective	Sort results by budget_id.
sort_budget_usage_7	SortDirective	Sort results by budget_usage_7.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_support	SortDirective	Sort results by campaign_optimization_support.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_status	SortDirective	Sort results by campaign_status.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_conversions_30	SortDirective	Sort results by conversions_30.
sort_current_account_currency	SortDirective	Sort results by current_account_currency.
sort_current_euros	SortDirective	Sort results by current_euros.
sort_est_optimal_spending	SortDirective	Sort results by est_optimal_spending.
sort_increase	SortDirective	Sort results by increase.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
sort_state	SortDirective	Sort results by state.
sort_suggested_account_currency	SortDirective	Sort results by suggested_account_currency.
sort_suggested_at	SortDirective	Sort results by suggested_at.
sort_suggested_euros	SortDirective	Sort results by suggested_euros.
sort_suggestion_id	SortDirective	Sort results by suggestion_id.
sort_updated_at	SortDirective	Sort results by updated_at.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_id searchable	String	Ad platform specific ID of an advertising account.
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
account_optimize	Boolean	If optimization by Adspert is enabled for this account.
account_tags_user searchable	[ String ]
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
performance_group_id searchable	Integer	Unique ID of the performance group
performance_group_name searchable	String	Unique name of the performance group.
performance_group_enabled	Boolean
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger
amz_portfolio_name searchable	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger
campaign_name searchable	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_status	CampaignStatus
campaign_optimize	Boolean
campaign_optimization_type	OptimizationType
campaign_optimization_support	CampaignOptimizationSupport
campaign_labels searchable	[ String ]
adspert_id	Integer	Internal Adspert ID for the budget suggestion
budget_id	Integer	Budget ID associated with the suggestion
increase	Boolean	True if the suggestion asks an increase in the current budget
account_currency	ApiCurrency
approved_euros	Micros	Approved budget amount in micros
approved_account_currency	Micros	Approved budget amount in micros
current_euros	Micros	Approved budget amount in micros
current_account_currency	Micros	Approved budget amount in micros
suggested_euros	Micros	Suggested budget amount in micros
suggested_account_currency	Micros	Suggested budget amount in micros
suggestion_id	Integer	Unique identifier for the suggestion
suggested_at	DateTime	Timestamp when the suggestion was made
updated_at	DateTime	Timestamp when the suggestion was last updated
state	BudgetSuggestionState	State of the budget suggestion
est_optimal_spending	Float	Estimated optimal spending amount
avg_cost_7	Integer	7-day average cost
avg_coverage_7	Float	7-day average coverage
budget_usage_7	Float	Budget usage
conversions_30	Integer	30-day conversion count
acos_30	Float	30-day Advertising Cost of Sales (ACoS)

Example

http

GET /v3/customers/7027038674/budget-suggestions?search_account_tags_user=dolor+elit&filter_current_account_currency=4940000&sort_account_optimize=0 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/budget-suggestions?search_account_tags_user=dolor+elit&filter_current_account_currency=4940000&sort_account_optimize=0' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/budget-suggestions?search_account_tags_user=dolor+elit&filter_current_account_currency=4940000&sort_account_optimize=0' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/budget-suggestions?search_account_tags_user=dolor+elit&filter_current_account_currency=4940000&sort_account_optimize=0', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "account_optimize": true,
      "account_tags_user": [
        "vehicula amet"
      ],
      "account_is_demo": true,
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_enabled": true,
      "performance_group_optimization_type": "CLICK",
      "performance_group_goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "campaign_eby_marketplace_id": "amet pariatur",
      "campaign_status": "ACTIVE",
      "campaign_optimize": true,
      "campaign_optimization_type": "CLICK",
      "campaign_optimization_support": "SUPPORTED",
      "campaign_labels": [
        "ipsum dolor"
      ],
      "adspert_id": 1931331423,
      "budget_id": 9532519855,
      "increase": true,
      "account_currency": "AED",
      "approved_euros": 2310000,
      "approved_account_currency": 8610000,
      "current_euros": 5840000,
      "current_account_currency": 4940000,
      "suggested_euros": 6920000,
      "suggested_account_currency": 6400000,
      "suggestion_id": 7559014817,
      "suggested_at": "2018-10-21T16:45:23+02:00",
      "updated_at": "2018-10-21T16:45:23+02:00",
      "state": "ACCEPTED",
      "est_optimal_spending": 7.8,
      "avg_cost_7": 1386737880,
      "avg_coverage_7": 11.43,
      "budget_usage_7": 4.09,
      "conversions_30": 682785560,
      "acos_30": 12.36
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "adspert_account_id": 1
      }
    }
  }
}

PATCH

PATCH /v3/customers/(customer_id: int)/budget-suggestions

Auth mode:

api-token

Access level:

user

Request Data (object list, json or csv)

Name	Type	Description
suggestion_id required	Integer	Unique identifier for the suggestion
approved_account_currency required	Micros	Approved budget amount in micros Min value: 1000

Response Data (single object, json or csv or xlsx)

Name	Type	Description
unchanged	[ Object ]	List of objects which had no effective change.
⤷ suggestion_id	Integer	See request data description.
⤷ approved_account_currency	Micros	See request data description.
unknown	[ Object ]	List of objects which could not be found.
⤷ suggestion_id	Integer	See request data description.
⤷ approved_account_currency	Micros	See request data description.
updated	[ Object ]	List of objects which have been updated.
⤷ suggestion_id	Integer	See request data description.
⤷ approved_account_currency	Micros	See request data description.

Example

http

PATCH /v3/customers/7027038674/budget-suggestions HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "suggestion_id": 7559014817,
    "approved_account_currency": 8610000
  }
]

curl

curl -i -X PATCH https://api.adspert.net/v3/customers/7027038674/budget-suggestions -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"suggestion_id": 7559014817, "approved_account_currency": 8610000}]'

httpie

echo '[
  {
    "approved_account_currency": 8610000,
    "suggestion_id": 7559014817
  }
]' | http PATCH https://api.adspert.net/v3/customers/7027038674/budget-suggestions Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.patch('https://api.adspert.net/v3/customers/7027038674/budget-suggestions', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'suggestion_id': 7559014817, 'approved_account_currency': 8610000}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "unchanged": [
      {
        "suggestion_id": 7559014817,
        "approved_account_currency": 8610000
      }
    ],
    "unknown": [
      {
        "suggestion_id": 7559014817,
        "approved_account_currency": 8610000
      }
    ],
    "updated": [
      {
        "suggestion_id": 7559014817,
        "approved_account_currency": 8610000
      }
    ]
  },
  "meta": {}
}

Criterion Addition

RuleCollection

GET

GET /v3/customers/(customer_id: int)/criterion-addition/rules

Get criterion addition rules.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_rule_level required	CriterionAdditionRuleLevel	Defines level of rules that will be returned in the response.
filter_rule_inherited	Boolean	Should only inherited / non-inherited (explicitly defined at the given level) rules be returned in the response?
filter_rule_type_id	[ LargeInteger ]	Only return results matching given rulesets.rule_type_id values.
filter_rule_id	[ LargeInteger ]	Only return results matching given rulesets.rules.rule_id values.
filter_rule_action	[ CriterionAdditionRuleAction ]	Only return results matching given rulesets.rules.action values.
filter_rule_platform	[ AdPlatform ]	Only return results where rule type platform matches the given string.
filter_adspert_account_id	[ Integer ]	Only return results matching given location.adspert_account_id values.
filter_account_id	[ String ]	Only return results matching given location.account_id values.
filter_account_name	[ String ]	Only return results matching given location.account_name values.
filter_account_platform	[ AdPlatform ]	Only return results matching given location.account_platform values.
filter_account_optimize	[ Boolean ]	Only return results matching given location.account_optimize values.
filter_account_tags_user	[ String ]	Only return results matching given location.account_tags_user values.
filter_account_is_demo	[ Boolean ]	Only return results matching given location.account_is_demo values.
filter_performance_group_id	[ Integer ]	Only return results matching given location.performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given location.performance_group_name values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given location.performance_group_enabled values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given location.performance_group_optimization_type values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given location.performance_group_goal_types values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given location.adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given location.amz_portfolio_name values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given location.adspert_campaign_id values.
filter_campaign_name	[ String ]	Only return results matching given location.campaign_name values.
filter_campaign_type	[ CampaignType ]	Only return results matching given location.campaign_type values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given location.campaign_eby_marketplace_id values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given location.campaign_status values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given location.campaign_optimize values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given location.campaign_optimization_type values.
filter_campaign_labels	[ String ]	Only return results matching given location.campaign_labels values.
filter_adspert_adgroup_id	[ CompositeID ]	Only return results matching given location.adspert_adgroup_id values.
filter_adgroup_name	[ String ]	Only return results matching given location.adgroup_name values.
filter_adgroup_status	[ AdgroupStatus ]	Only return results matching given location.adgroup_status values.
filter_adgroup_labels	[ String ]	Only return results matching given location.adgroup_labels values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where location.account_id matches the given string.
search_account_name	String	Only return results where location.account_name matches the given string.
search_account_tags_user	String	Only return results where location.account_tags_user matches the given string.
search_performance_group_name	String	Only return results where location.performance_group_name matches the given string.
search_portfolio_name	String	Only return results where location.portfolio_name matches the given string.
search_campaign_name	String	Only return results where location.campaign_name matches the given string.
search_campaign_labels	[ String ]	Only return results where location.campaign_labels matches the given string.
search_adgroup_name	String	Only return results where location.adgroup_name matches the given string.
search_adgroup_labels	[ String ]	Only return results where location.adgroup_labels matches the given string.
sort_platform	SortDirective	Sort results by location.platform.
sort_adspert_account_id	SortDirective	Sort results by location.adspert_account_id.
sort_adspert_campaign_id	SortDirective	Sort results by location.adspert_campaign_id.
sort_adspert_adgroup_id	SortDirective	Sort results by location.adspert_adgroup_id.
sort_account_name	SortDirective	Sort results by location.account_name.
sort_campaign_name	SortDirective	Sort results by location.campaign_name.
sort_adgroup_name	SortDirective	Sort results by location.adgroup_name.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
location	Object	Location for which the rulesets are defined or inherited. Location essentially is a combination of level + IDs.
⤷ level	CriterionAdditionRuleLevel
⤷ platform	AdPlatform
⤷ adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
⤷ account_id searchable	String	Ad platform specific ID of an advertising account.
⤷ account_name searchable	String
⤷ account_platform	AdPlatform	The account’s advertising platform.
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id searchable	LargeInteger
⤷ campaign_name searchable	String
⤷ campaign_type	CampaignType
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_id searchable	LargeInteger
⤷ adgroup_name searchable	String
rulesets	[ Object ]	List of rulesets that apply to the given location.
⤷ rule_type_id	Integer	Id of the Rule Type the ruleset is defined for.
⤷ defined_at	Object	Where is the ruleset defined? This can be different from location for rulesets that are inherited.
⤷ level	CriterionAdditionRuleLevel
⤷ platform	AdPlatform
⤷ adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
⤷ account_id searchable	String	Ad platform specific ID of an advertising account.
⤷ account_name searchable	String
⤷ account_platform	AdPlatform	The account’s advertising platform.
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id searchable	LargeInteger
⤷ campaign_name searchable	String
⤷ campaign_type	CampaignType
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_id searchable	LargeInteger
⤷ adgroup_name searchable	String
⤷ inherited	Boolean	Is the ruleset inherited? If true, defined_at will have details about the ‘location’ that the rule is inherited from.
⤷ rules	[ Object ]	A set of rules that are part of the ruleset. This list will either contain a single rule without filters or have at least 2 rules where one of them has filters and one of them is marked as catch-all.
⤷ rule_id	LargeInteger	Unique ID of the rule
⤷ action	CriterionAdditionRuleAction	Action that Adspert is supposed to take when generating proposals that match this rule.
⤷ filters	[ Object ]	Additional filters that will be evaluated when matching proposals to the rule. If multiple filters are defined, all of them have to match the proposal, or else the catch-all rule will be used. Each ruleset that contains a rule with filters has to also contain exactly one catch-all rule.
⤷ operand	CriterionAdditionRuleFilterOperand	Rule filter operand.
⤷ operation	CriterionAdditionRuleFilterOperation	Rule filter operation.
⤷ values	[ Any ]	Rule filter values.
⤷ catch_all	Boolean	Is the rule supposed to be used as a catch-all?
⤷ destinations	[ Object ]	A set of destinations that Adspert is supposed to create for each proposal that matches the rule.
⤷ destination_id	LargeInteger
⤷ destination_type	CriterionAdditionDestinationType
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. This field is populated only for SELECTED-ADGROUP destinations. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_id searchable	LargeInteger	This field is populated only for SELECTED-ADGROUP destinations.
⤷ match_type	CriterionAdditionMatchType	This field is populated only for destinations that belong to KEYWORD rules.
⤷ negative	Boolean
⤷ created_at	DateTime
⤷ effective_destination	Object	Effective destination is available only for adgroup-level requests. It’s NULL for all other levels.
⤷ campaign_id searchable	LargeInteger
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_name searchable	String
⤷ adgroup_id searchable	LargeInteger
⤷ adgroup_name searchable	String
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ product_ad_sync_mode	ProductAdSyncMode	This field is populated only when there is a product ad sync set up between the source adgroup that this rule is active for and the target adgroup referenced in this effective destination.
⤷ created_at	DateTime

Example

http

GET /v3/customers/7027038674/criterion-addition/rules?search_adgroup_name=adlora+ipsum&sort_adspert_adgroup_id=9&filter_campaign_status=ACTIVE HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/rules?search_adgroup_name=adlora+ipsum&sort_adspert_adgroup_id=9&filter_campaign_status=ACTIVE' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/rules?search_adgroup_name=adlora+ipsum&sort_adspert_adgroup_id=9&filter_campaign_status=ACTIVE' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/criterion-addition/rules?search_adgroup_name=adlora+ipsum&sort_adspert_adgroup_id=9&filter_campaign_status=ACTIVE', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "location": {
        "level": "ACCOUNT",
        "platform": "AMAZON",
        "adspert_account_id": 123,
        "account_id": "amet lorem",
        "account_name": "vehicula ipsum",
        "account_platform": "AMAZON",
        "adspert_campaign_id": "123:5555",
        "campaign_id": "5555",
        "campaign_name": "sit ipsum",
        "campaign_type": "AMAZON-SPONSORED-BRANDS",
        "adspert_adgroup_id": "123:777",
        "adgroup_id": "777",
        "adgroup_name": "tucan lorem"
      },
      "rulesets": [
        {
          "rule_type_id": 5675219470,
          "defined_at": {
            "level": "ACCOUNT",
            "platform": "AMAZON",
            "adspert_account_id": 123,
            "account_id": "amet lorem",
            "account_name": "vehicula ipsum",
            "account_platform": "AMAZON",
            "adspert_campaign_id": "123:5555",
            "campaign_id": "5555",
            "campaign_name": "sit ipsum",
            "campaign_type": "AMAZON-SPONSORED-BRANDS",
            "adspert_adgroup_id": "123:777",
            "adgroup_id": "777",
            "adgroup_name": "tucan lorem"
          },
          "inherited": true,
          "rules": [
            {
              "rule_id": "49754540226638646583189955",
              "action": "ADD",
              "filters": [
                {
                  "operand": "DOMAIN",
                  "operation": "CONTAINS",
                  "values": [
                    1
                  ]
                }
              ],
              "catch_all": true,
              "destinations": [
                {
                  "destination_id": "78046413193991906103940983",
                  "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
                  "adspert_adgroup_id": "123:777",
                  "adgroup_id": "777",
                  "match_type": "BROAD",
                  "negative": true,
                  "created_at": "2018-10-21T16:45:23+02:00",
                  "effective_destination": {
                    "campaign_id": "5555",
                    "adspert_campaign_id": "123:5555",
                    "campaign_name": "sit ipsum",
                    "adgroup_id": "777",
                    "adgroup_name": "tucan lorem",
                    "adspert_adgroup_id": "123:777",
                    "product_ad_sync_mode": "ADD-MISSING"
                  }
                }
              ],
              "created_at": "2018-10-21T16:45:23+02:00"
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "location": 1
      }
    }
  }
}

PUT

PUT /v3/customers/(customer_id: int)/criterion-addition/rules

Update/create criterion addition rules.

Auth mode:

api-token

Access level:

user

Request Data (object list, json)

Name	Type	Description
rule_type_id required	Integer	Id of the Rule Type the ruleset is defined for.
level required	CriterionAdditionRuleLevel	Level at which the ruleset should be created.
adspert_account_id	Integer	ID of the account for which the ruleset should be created. This field is required (and allowed only) at the ACCOUNT level.
adspert_campaign_id	CompositeID	ID of the campaign for which the ruleset should be created. This field is required (and allowed only) at the CAMPAIGN level. Composite ID specification: {adspert_account_id}:{campaign_id}
adspert_adgroup_id	CompositeID	ID of the adgroup for which the ruleset should be created. This field is required (and allowed only) at the ADGROUP level. Composite ID specification: {adspert_account_id}:{adgroup_id}
rules required	[ Object ]	If there is no need for rule filters, the rules array should contain exactly one rule. If there is a need for filters, rules array should contain: * at least one rule with filters * exactly one rule marked as catch-all If there already are rules defined at the location, any rule that’s not referenced in the request will be deleted. Min items: 1
⤷ rule_id	LargeInteger	ID of a rule to update. Updating a rule without this field set, will result in a replacement of that rule. The changelog will show a removal of the previous rule and creation of the updated one. Updating a rule with this field set, will update the rule. The changelog will show an update of the existing rule. The implicit type of the rule (simple, filtered, or catch-all) cannot be changed during the update.
⤷ action required	CriterionAdditionRuleAction	Action that Adspert is supposed to take when generating proposals that match this rule.
⤷ filters	[ Object ]	Additional filters that will be evaluated when matching proposals to the rule. If multiple filters are defined, all of them have to match the proposal, or else the catch-all rule will be used. Each ruleset that contains a rule with filters has to also contain exactly one catch-all rule.
⤷ operand	CriterionAdditionRuleFilterOperand	See request data description.
⤷ operation	CriterionAdditionRuleFilterOperation	See request data description.
⤷ values	[ Any ]	See request data description.
⤷ catch_all	Boolean	Is the rule supposed to be used as a catch-all?
⤷ destinations	[ Object ]	A set of destinations that Adspert is supposed to create for each proposal that matches the rule. Proposals where action is set to reject, cannot have any destinations. Proposals where action is set to add have to have at least one destination.
⤷ destination_type	CriterionAdditionDestinationType	See request data description.
⤷ adspert_adgroup_id	CompositeID	See request data description.
⤷ match_type	CriterionAdditionMatchType	See request data description.
⤷ negative	Boolean	See request data description.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
created	[ Object ]	List of objects which have been created.
⤷ rule_type_id	Integer	See request data description.
⤷ level	CriterionAdditionRuleLevel	See request data description.
⤷ adspert_account_id	Integer	See request data description.
⤷ adspert_campaign_id	CompositeID	See request data description.
⤷ adspert_adgroup_id	CompositeID	See request data description.
⤷ rules	[ Object ]	See request data description.
⤷ rule_id	LargeInteger	See request data description.
⤷ action	CriterionAdditionRuleAction	See request data description.
⤷ filters	[ Object ]	See request data description.
⤷ operand	CriterionAdditionRuleFilterOperand	See request data description.
⤷ operation	CriterionAdditionRuleFilterOperation	See request data description.
⤷ values	[ Any ]	See request data description.
⤷ catch_all	Boolean	See request data description.
⤷ destinations	[ Object ]	See request data description.
⤷ destination_type	CriterionAdditionDestinationType	See request data description.
⤷ adspert_adgroup_id	CompositeID	See request data description.
⤷ match_type	CriterionAdditionMatchType	See request data description.
⤷ negative	Boolean	See request data description.
unchanged	[ Object ]	List of objects which had no effective change.
⤷ rule_type_id	Integer	See request data description.
⤷ level	CriterionAdditionRuleLevel	See request data description.
⤷ adspert_account_id	Integer	See request data description.
⤷ adspert_campaign_id	CompositeID	See request data description.
⤷ adspert_adgroup_id	CompositeID	See request data description.
⤷ rules	[ Object ]	See request data description.
⤷ rule_id	LargeInteger	See request data description.
⤷ action	CriterionAdditionRuleAction	See request data description.
⤷ filters	[ Object ]	See request data description.
⤷ operand	CriterionAdditionRuleFilterOperand	See request data description.
⤷ operation	CriterionAdditionRuleFilterOperation	See request data description.
⤷ values	[ Any ]	See request data description.
⤷ catch_all	Boolean	See request data description.
⤷ destinations	[ Object ]	See request data description.
⤷ destination_type	CriterionAdditionDestinationType	See request data description.
⤷ adspert_adgroup_id	CompositeID	See request data description.
⤷ match_type	CriterionAdditionMatchType	See request data description.
⤷ negative	Boolean	See request data description.
updated	[ Object ]	List of objects which have been updated.
⤷ rule_type_id	Integer	See request data description.
⤷ level	CriterionAdditionRuleLevel	See request data description.
⤷ adspert_account_id	Integer	See request data description.
⤷ adspert_campaign_id	CompositeID	See request data description.
⤷ adspert_adgroup_id	CompositeID	See request data description.
⤷ rules	[ Object ]	See request data description.
⤷ rule_id	LargeInteger	See request data description.
⤷ action	CriterionAdditionRuleAction	See request data description.
⤷ filters	[ Object ]	See request data description.
⤷ operand	CriterionAdditionRuleFilterOperand	See request data description.
⤷ operation	CriterionAdditionRuleFilterOperation	See request data description.
⤷ values	[ Any ]	See request data description.
⤷ catch_all	Boolean	See request data description.
⤷ destinations	[ Object ]	See request data description.
⤷ destination_type	CriterionAdditionDestinationType	See request data description.
⤷ adspert_adgroup_id	CompositeID	See request data description.
⤷ match_type	CriterionAdditionMatchType	See request data description.
⤷ negative	Boolean	See request data description.

Example

http

PUT /v3/customers/7027038674/criterion-addition/rules HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "rule_type_id": 5675219470,
    "level": "ACCOUNT",
    "adspert_account_id": 123,
    "adspert_campaign_id": "123:5555",
    "adspert_adgroup_id": "123:777",
    "rules": [
      {
        "rule_id": "49754540226638646583189955",
        "action": "ADD",
        "filters": [
          {
            "operand": "DOMAIN",
            "operation": "CONTAINS",
            "values": [
              1
            ]
          }
        ],
        "catch_all": true,
        "destinations": [
          {
            "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
            "adspert_adgroup_id": "123:777",
            "match_type": "BROAD",
            "negative": true
          }
        ]
      }
    ]
  }
]

curl

curl -i -X PUT https://api.adspert.net/v3/customers/7027038674/criterion-addition/rules -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"rule_type_id": 5675219470, "level": "ACCOUNT", "adspert_account_id": 123, "adspert_campaign_id": "123:5555", "adspert_adgroup_id": "123:777", "rules": [{"rule_id": "49754540226638646583189955", "action": "ADD", "filters": [{"operand": "DOMAIN", "operation": "CONTAINS", "values": [1]}], "catch_all": true, "destinations": [{"destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP", "adspert_adgroup_id": "123:777", "match_type": "BROAD", "negative": true}]}]}]'

httpie

echo '[
  {
    "adspert_account_id": 123,
    "adspert_adgroup_id": "123:777",
    "adspert_campaign_id": "123:5555",
    "level": "ACCOUNT",
    "rule_type_id": 5675219470,
    "rules": [
      {
        "action": "ADD",
        "catch_all": true,
        "destinations": [
          {
            "adspert_adgroup_id": "123:777",
            "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
            "match_type": "BROAD",
            "negative": true
          }
        ],
        "filters": [
          {
            "operand": "DOMAIN",
            "operation": "CONTAINS",
            "values": [
              1
            ]
          }
        ],
        "rule_id": "49754540226638646583189955"
      }
    ]
  }
]' | http PUT https://api.adspert.net/v3/customers/7027038674/criterion-addition/rules Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.put('https://api.adspert.net/v3/customers/7027038674/criterion-addition/rules', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'rule_type_id': 5675219470, 'level': 'ACCOUNT', 'adspert_account_id': 123, 'adspert_campaign_id': '123:5555', 'adspert_adgroup_id': '123:777', 'rules': [{'rule_id': '49754540226638646583189955', 'action': 'ADD', 'filters': [{'operand': 'DOMAIN', 'operation': 'CONTAINS', 'values': [1]}], 'catch_all': True, 'destinations': [{'destination_type': 'AMAZON-CREATE-BRAND-KEYWORD-ADGROUP', 'adspert_adgroup_id': '123:777', 'match_type': 'BROAD', 'negative': True}]}]}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "created": [
      {
        "rule_type_id": 5675219470,
        "level": "ACCOUNT",
        "adspert_account_id": 123,
        "adspert_campaign_id": "123:5555",
        "adspert_adgroup_id": "123:777",
        "rules": [
          {
            "rule_id": "49754540226638646583189955",
            "action": "ADD",
            "filters": [
              {
                "operand": "DOMAIN",
                "operation": "CONTAINS",
                "values": [
                  1
                ]
              }
            ],
            "catch_all": true,
            "destinations": [
              {
                "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
                "adspert_adgroup_id": "123:777",
                "match_type": "BROAD",
                "negative": true
              }
            ]
          }
        ]
      }
    ],
    "unchanged": [
      {
        "rule_type_id": 5675219470,
        "level": "ACCOUNT",
        "adspert_account_id": 123,
        "adspert_campaign_id": "123:5555",
        "adspert_adgroup_id": "123:777",
        "rules": [
          {
            "rule_id": "49754540226638646583189955",
            "action": "ADD",
            "filters": [
              {
                "operand": "DOMAIN",
                "operation": "CONTAINS",
                "values": [
                  1
                ]
              }
            ],
            "catch_all": true,
            "destinations": [
              {
                "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
                "adspert_adgroup_id": "123:777",
                "match_type": "BROAD",
                "negative": true
              }
            ]
          }
        ]
      }
    ],
    "updated": [
      {
        "rule_type_id": 5675219470,
        "level": "ACCOUNT",
        "adspert_account_id": 123,
        "adspert_campaign_id": "123:5555",
        "adspert_adgroup_id": "123:777",
        "rules": [
          {
            "rule_id": "49754540226638646583189955",
            "action": "ADD",
            "filters": [
              {
                "operand": "DOMAIN",
                "operation": "CONTAINS",
                "values": [
                  1
                ]
              }
            ],
            "catch_all": true,
            "destinations": [
              {
                "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
                "adspert_adgroup_id": "123:777",
                "match_type": "BROAD",
                "negative": true
              }
            ]
          }
        ]
      }
    ]
  },
  "meta": {}
}

DELETE

DELETE /v3/customers/(customer_id: int)/criterion-addition/rules

Delete criterion addition rules.

Auth mode:

api-token

Access level:

user

Request Data (object list, json or csv)

Name	Type	Description
rule_type_id required	Integer	Id of the Rule Type the ruleset is defined for.
level required	CriterionAdditionRuleLevel	Level of the ruleset that should be deleted.
adspert_account_id	Integer	ID of the account for which the ruleset should be deleted. This field is required (and allowed only) at the ACCOUNT level.
adspert_campaign_id	CompositeID	ID of the campaign for which the ruleset should be deleted. This field is required (and allowed only) at the CAMPAIGN level. Composite ID specification: {adspert_account_id}:{campaign_id}
adspert_adgroup_id	CompositeID	ID of the adgroup for which the ruleset should be deleted. This field is required (and allowed only) at the ADGROUP level. Composite ID specification: {adspert_account_id}:{adgroup_id}

Response Data (single object, json or csv or xlsx)

Name	Type	Description
deleted	[ Object ]	List of objects which have been deleted.
⤷ rule_type_id	Integer	See request data description.
⤷ level	CriterionAdditionRuleLevel	See request data description.
⤷ adspert_account_id	Integer	See request data description.
⤷ adspert_campaign_id	CompositeID	See request data description.
⤷ adspert_adgroup_id	CompositeID	See request data description.
unknown	[ Object ]	List of objects which could not be found.
⤷ rule_type_id	Integer	See request data description.
⤷ level	CriterionAdditionRuleLevel	See request data description.
⤷ adspert_account_id	Integer	See request data description.
⤷ adspert_campaign_id	CompositeID	See request data description.
⤷ adspert_adgroup_id	CompositeID	See request data description.

Example

http

DELETE /v3/customers/7027038674/criterion-addition/rules HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "rule_type_id": 5675219470,
    "level": "ACCOUNT",
    "adspert_account_id": 123,
    "adspert_campaign_id": "123:5555",
    "adspert_adgroup_id": "123:777"
  }
]

curl

curl -i -X DELETE https://api.adspert.net/v3/customers/7027038674/criterion-addition/rules -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"rule_type_id": 5675219470, "level": "ACCOUNT", "adspert_account_id": 123, "adspert_campaign_id": "123:5555", "adspert_adgroup_id": "123:777"}]'

httpie

echo '[
  {
    "adspert_account_id": 123,
    "adspert_adgroup_id": "123:777",
    "adspert_campaign_id": "123:5555",
    "level": "ACCOUNT",
    "rule_type_id": 5675219470
  }
]' | http DELETE https://api.adspert.net/v3/customers/7027038674/criterion-addition/rules Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.delete('https://api.adspert.net/v3/customers/7027038674/criterion-addition/rules', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'rule_type_id': 5675219470, 'level': 'ACCOUNT', 'adspert_account_id': 123, 'adspert_campaign_id': '123:5555', 'adspert_adgroup_id': '123:777'}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "deleted": [
      {
        "rule_type_id": 5675219470,
        "level": "ACCOUNT",
        "adspert_account_id": 123,
        "adspert_campaign_id": "123:5555",
        "adspert_adgroup_id": "123:777"
      }
    ],
    "unknown": [
      {
        "rule_type_id": 5675219470,
        "level": "ACCOUNT",
        "adspert_account_id": 123,
        "adspert_campaign_id": "123:5555",
        "adspert_adgroup_id": "123:777"
      }
    ]
  },
  "meta": {}
}

ProposalCollection

GET

GET /v3/customers/(customer_id: int)/criterion-addition/proposals

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_impressions_le	Integer	Only return results where metrics.impressions is equal or lower than this value.
filter_impressions_ge	Integer	Only return results where metrics.impressions is equal or greater than this value.
filter_clicks_le	Integer	Only return results where metrics.clicks is equal or lower than this value.
filter_clicks_ge	Integer	Only return results where metrics.clicks is equal or greater than this value.
filter_conversions_le	Float	Only return results where metrics.conversions is equal or lower than this value.
filter_conversions_ge	Float	Only return results where metrics.conversions is equal or greater than this value.
filter_cost_le	Micros	Only return results where metrics.cost is equal or lower than this value. Min value: 1000
filter_cost_ge	Micros	Only return results where metrics.cost is equal or greater than this value. Min value: 1000
filter_profit_gross_le	Micros	Only return results where metrics.profit_gross is equal or lower than this value. Min value: 1000
filter_profit_gross_ge	Micros	Only return results where metrics.profit_gross is equal or greater than this value. Min value: 1000
filter_profit_net_le	Micros	Only return results where metrics.profit_net is equal or lower than this value. Min value: 1000
filter_profit_net_ge	Micros	Only return results where metrics.profit_net is equal or greater than this value. Min value: 1000
filter_revenue_le	Micros	Only return results where metrics.revenue is equal or lower than this value. Min value: 1000
filter_revenue_ge	Micros	Only return results where metrics.revenue is equal or greater than this value. Min value: 1000
filter_cost_per_click_le	Micros	Only return results where metrics.cost_per_click is equal or lower than this value. Min value: 1000
filter_cost_per_click_ge	Micros	Only return results where metrics.cost_per_click is equal or greater than this value. Min value: 1000
filter_cost_per_conversion_le	Micros	Only return results where metrics.cost_per_conversion is equal or lower than this value. Min value: 1000
filter_cost_per_conversion_ge	Micros	Only return results where metrics.cost_per_conversion is equal or greater than this value. Min value: 1000
filter_revenue_per_conversion_le	Micros	Only return results where metrics.revenue_per_conversion is equal or lower than this value. Min value: 1000
filter_revenue_per_conversion_ge	Micros	Only return results where metrics.revenue_per_conversion is equal or greater than this value. Min value: 1000
filter_conversion_rate_le	Float	Only return results where metrics.conversion_rate is equal or lower than this value.
filter_conversion_rate_ge	Float	Only return results where metrics.conversion_rate is equal or greater than this value.
filter_click_through_rate_le	Float	Only return results where metrics.click_through_rate is equal or lower than this value.
filter_click_through_rate_ge	Float	Only return results where metrics.click_through_rate is equal or greater than this value.
filter_return_on_investment_le	Float	Only return results where metrics.return_on_investment is equal or lower than this value.
filter_return_on_investment_ge	Float	Only return results where metrics.return_on_investment is equal or greater than this value.
filter_return_on_ad_spend_le	Float	Only return results where metrics.return_on_ad_spend is equal or lower than this value.
filter_return_on_ad_spend_ge	Float	Only return results where metrics.return_on_ad_spend is equal or greater than this value.
filter_cost_revenue_ratio_le	Float	Only return results where metrics.cost_revenue_ratio is equal or lower than this value.
filter_cost_revenue_ratio_ge	Float	Only return results where metrics.cost_revenue_ratio is equal or greater than this value.
filter_account_id	[ String ]	Only return results matching given source.account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given source.account_is_demo values.
filter_account_name	[ String ]	Only return results matching given source.account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given source.account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given source.account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given source.account_tags_user values.
filter_adspert_account_id	[ Integer ]	Only return results matching given source.adspert_account_id values.
filter_criterion_name	[ String ]	Only return results matching given criterion_name values.
filter_criterion_subtype	[ CriterionAdditionCriterionSubtype ]	Only return results matching given criterion_subtype values.
filter_criterion_type	[ CriterionAdditionCriterionType ]	Only return results matching given criterion_type values.
filter_destination_adgroup_labels	[ String ]	Only return results matching given destinations.effective_destination.adgroup_labels values.
filter_destination_adgroup_name	[ String ]	Only return results matching given destinations.effective_destination.adgroup_name values.
filter_destination_adgroup_status	[ AdgroupStatus ]	Only return results matching given destinations.effective_destination.adgroup_status values.
filter_destination_adspert_adgroup_id	[ CompositeID ]	Only return results matching given destinations.effective_destination.adspert_adgroup_id values.
filter_destination_adspert_campaign_id	[ CompositeID ]	Only return results matching given destinations.effective_destination.adspert_campaign_id values.
filter_destination_adspert_portfolio_id	[ CompositeID ]	Only return results matching given destinations.effective_destination.adspert_portfolio_id values.
filter_destination_amz_portfolio_name	[ String ]	Only return results matching given destinations.effective_destination.amz_portfolio_name values.
filter_destination_campaign_eby_marketplace_id	[ String ]	Only return results matching given destinations.effective_destination.campaign_eby_marketplace_id values.
filter_destination_campaign_labels	[ String ]	Only return results matching given destinations.effective_destination.campaign_labels values.
filter_destination_campaign_name	[ String ]	Only return results matching given destinations.effective_destination.campaign_name values.
filter_destination_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given destinations.effective_destination.campaign_optimization_support values.
filter_destination_campaign_optimization_type	[ OptimizationType ]	Only return results matching given destinations.effective_destination.campaign_optimization_type values.
filter_destination_campaign_optimize	[ Boolean ]	Only return results matching given destinations.effective_destination.campaign_optimize values.
filter_destination_campaign_status	[ CampaignStatus ]	Only return results matching given destinations.effective_destination.campaign_status values.
filter_destination_campaign_type	[ CampaignType ]	Only return results matching given destinations.effective_destination.campaign_type values.
filter_destination_id	[ LargeInteger ]	Only return results matching given destinations.destination_id values.
filter_destination_performance_group_enabled	[ Boolean ]	Only return results matching given destinations.effective_destination.performance_group_enabled values.
filter_destination_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given destinations.effective_destination.performance_group_goal_types values.
filter_destination_performance_group_id	[ Integer ]	Only return results matching given destinations.effective_destination.performance_group_id values.
filter_destination_performance_group_name	[ String ]	Only return results matching given destinations.effective_destination.performance_group_name values.
filter_destination_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given destinations.effective_destination.performance_group_optimization_type values.
filter_destination_type	[ CriterionAdditionDestinationType ]	Only return results matching given destinations.destination_type values.
filter_proposal_id	[ LargeInteger ]	Only return results matching given proposal_id values.
filter_proposal_reasons	[ CriterionAdditionProposalReason ]	Only return results matching given proposal_reasons values.
filter_proposal_state	[ CriterionAdditionProposalState ]	Only return results matching given proposal_state values.
filter_proposal_type	[ CriterionAdditionProposalType ]	Only return results matching given proposal_type values.
filter_rule_type_id	[ Integer ]	Only return results matching given rule_type_id values.
filter_source_adgroup_labels	[ String ]	Only return results matching given source.adgroup_labels values.
filter_source_adgroup_name	[ String ]	Only return results matching given source.adgroup_name values.
filter_source_adgroup_status	[ AdgroupStatus ]	Only return results matching given source.adgroup_status values.
filter_source_adspert_adgroup_id	[ CompositeID ]	Only return results matching given source.adspert_adgroup_id values.
filter_source_adspert_campaign_id	[ CompositeID ]	Only return results matching given source.adspert_campaign_id values.
filter_source_adspert_portfolio_id	[ CompositeID ]	Only return results matching given source.adspert_portfolio_id values.
filter_source_amz_portfolio_name	[ String ]	Only return results matching given source.amz_portfolio_name values.
filter_source_campaign_eby_marketplace_id	[ String ]	Only return results matching given source.campaign_eby_marketplace_id values.
filter_source_campaign_labels	[ String ]	Only return results matching given source.campaign_labels values.
filter_source_campaign_name	[ String ]	Only return results matching given source.campaign_name values.
filter_source_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given source.campaign_optimization_support values.
filter_source_campaign_optimization_type	[ OptimizationType ]	Only return results matching given source.campaign_optimization_type values.
filter_source_campaign_optimize	[ Boolean ]	Only return results matching given source.campaign_optimize values.
filter_source_campaign_status	[ CampaignStatus ]	Only return results matching given source.campaign_status values.
filter_source_campaign_type	[ CampaignType ]	Only return results matching given source.campaign_type values.
filter_source_performance_group_enabled	[ Boolean ]	Only return results matching given source.performance_group_enabled values.
filter_source_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given source.performance_group_goal_types values.
filter_source_performance_group_id	[ Integer ]	Only return results matching given source.performance_group_id values.
filter_source_performance_group_name	[ String ]	Only return results matching given source.performance_group_name values.
filter_source_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given source.performance_group_optimization_type values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where source.account_id matches the given string.
search_account_name	String	Only return results where source.account_name matches the given string.
search_account_tags_user	String	Only return results where source.account_tags_user matches the given string.
search_adspert_account_id	String	Only return results where source.adspert_account_id matches the given string.
search_criterion_name	String	Only return results where criterion_name matches the given string.
search_destination_adgroup_id	String	Only return results where destinations.effective_destination.adgroup_id matches the given string.
search_destination_adgroup_labels	String	Only return results where destinations.effective_destination.adgroup_labels matches the given string.
search_destination_adgroup_name	String	Only return results where destinations.effective_destination.adgroup_name matches the given string.
search_destination_amz_portfolio_id	String	Only return results where destinations.effective_destination.amz_portfolio_id matches the given string.
search_destination_amz_portfolio_name	String	Only return results where destinations.effective_destination.amz_portfolio_name matches the given string.
search_destination_campaign_id	String	Only return results where destinations.effective_destination.campaign_id matches the given string.
search_destination_campaign_labels	String	Only return results where destinations.effective_destination.campaign_labels matches the given string.
search_destination_campaign_name	String	Only return results where destinations.effective_destination.campaign_name matches the given string.
search_destination_performance_group_id	String	Only return results where destinations.effective_destination.performance_group_id matches the given string.
search_destination_performance_group_name	String	Only return results where destinations.effective_destination.performance_group_name matches the given string.
search_source_adgroup_id	String	Only return results where source.adgroup_id matches the given string.
search_source_adgroup_labels	String	Only return results where source.adgroup_labels matches the given string.
search_source_adgroup_name	String	Only return results where source.adgroup_name matches the given string.
search_source_amz_portfolio_id	String	Only return results where source.amz_portfolio_id matches the given string.
search_source_amz_portfolio_name	String	Only return results where source.amz_portfolio_name matches the given string.
search_source_campaign_id	String	Only return results where source.campaign_id matches the given string.
search_source_campaign_labels	String	Only return results where source.campaign_labels matches the given string.
search_source_campaign_name	String	Only return results where source.campaign_name matches the given string.
search_source_performance_group_id	String	Only return results where source.performance_group_id matches the given string.
search_source_performance_group_name	String	Only return results where source.performance_group_name matches the given string.
sort_account_id	SortDirective	Sort results by source.account_id.
sort_account_is_demo	SortDirective	Sort results by source.account_is_demo.
sort_account_name	SortDirective	Sort results by source.account_name.
sort_account_optimize	SortDirective	Sort results by source.account_optimize.
sort_account_platform	SortDirective	Sort results by source.account_platform.
sort_adspert_account_id	SortDirective	Sort results by source.adspert_account_id.
sort_click_through_rate	SortDirective	Sort results by metrics.click_through_rate.
sort_clicks	SortDirective	Sort results by metrics.clicks.
sort_conversion_rate	SortDirective	Sort results by metrics.conversion_rate.
sort_conversions	SortDirective	Sort results by metrics.conversions.
sort_cost	SortDirective	Sort results by metrics.cost.
sort_cost_per_click	SortDirective	Sort results by metrics.cost_per_click.
sort_cost_per_conversion	SortDirective	Sort results by metrics.cost_per_conversion.
sort_cost_revenue_ratio	SortDirective	Sort results by metrics.cost_revenue_ratio.
sort_criterion_name	SortDirective	Sort results by criterion_name.
sort_criterion_subtype	SortDirective	Sort results by criterion_subtype.
sort_criterion_type	SortDirective	Sort results by criterion_type.
sort_impressions	SortDirective	Sort results by metrics.impressions.
sort_profit_gross	SortDirective	Sort results by metrics.profit_gross.
sort_profit_net	SortDirective	Sort results by metrics.profit_net.
sort_proposal_id	SortDirective	Sort results by proposal_id.
sort_proposal_state	SortDirective	Sort results by proposal_state.
sort_proposal_type	SortDirective	Sort results by proposal_type.
sort_return_on_ad_spend	SortDirective	Sort results by metrics.return_on_ad_spend.
sort_return_on_investment	SortDirective	Sort results by metrics.return_on_investment.
sort_revenue	SortDirective	Sort results by metrics.revenue.
sort_revenue_per_conversion	SortDirective	Sort results by metrics.revenue_per_conversion.
sort_rule_type_id	SortDirective	Sort results by rule_type_id.
sort_source_adgroup_id	SortDirective	Sort results by source.adgroup_id.
sort_source_adgroup_name	SortDirective	Sort results by source.adgroup_name.
sort_source_adgroup_status	SortDirective	Sort results by source.adgroup_status.
sort_source_adspert_adgroup_id	SortDirective	Sort results by source.adspert_adgroup_id.
sort_source_adspert_campaign_id	SortDirective	Sort results by source.adspert_campaign_id.
sort_source_adspert_portfolio_id	SortDirective	Sort results by source.adspert_portfolio_id.
sort_source_amz_portfolio_id	SortDirective	Sort results by source.amz_portfolio_id.
sort_source_amz_portfolio_name	SortDirective	Sort results by source.amz_portfolio_name.
sort_source_campaign_eby_marketplace_id	SortDirective	Sort results by source.campaign_eby_marketplace_id.
sort_source_campaign_id	SortDirective	Sort results by source.campaign_id.
sort_source_campaign_name	SortDirective	Sort results by source.campaign_name.
sort_source_campaign_optimization_support	SortDirective	Sort results by source.campaign_optimization_support.
sort_source_campaign_optimization_type	SortDirective	Sort results by source.campaign_optimization_type.
sort_source_campaign_optimize	SortDirective	Sort results by source.campaign_optimize.
sort_source_campaign_status	SortDirective	Sort results by source.campaign_status.
sort_source_campaign_type	SortDirective	Sort results by source.campaign_type.
sort_source_performance_group_enabled	SortDirective	Sort results by source.performance_group_enabled.
sort_source_performance_group_goal_types	SortDirective	Sort results by source.performance_group_goal_types.
sort_source_performance_group_id	SortDirective	Sort results by source.performance_group_id.
sort_source_performance_group_name	SortDirective	Sort results by source.performance_group_name.
sort_source_performance_group_optimization_type	SortDirective	Sort results by source.performance_group_optimization_type.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1
currency	Currency	Currency for all of the monetary metrics in the metrics section of the response. Defaults to EUR, if not specified in the request. Default: EUR

Response Data (object list, json or csv or xlsx)

Name	Type	Description
proposal_id	LargeInteger	Unique ID of the proposal.
rule_type_id	Integer	Id of the matched Rule Type.
proposal_type	CriterionAdditionProposalType	Type of the proposal.
proposal_reasons	[ CriterionAdditionProposalReason ]	A list of reasons why the proposal was generated.
proposal_state	CriterionAdditionProposalState	State of the proposal.
criterion_type	CriterionAdditionCriterionType	Type of criterion proposed to be created.
criterion_subtype	CriterionAdditionCriterionSubtype	Subtype of criterion proposed to be created.
criterion_name searchable	String	Name of criterion proposed to be created.
forced_review_reasons	[ CriterionAdditionForcedReviewReason ]	If proposal was forced into the review states, those are the reasons why.
source	Object
⤷ adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
⤷ account_id searchable	String	Ad platform specific ID of an advertising account.
⤷ account_name searchable	String
⤷ account_platform	AdPlatform	The account’s advertising platform.
⤷ account_optimize	Boolean	If optimization by Adspert is enabled for this account.
⤷ account_tags_user searchable	[ String ]
⤷ account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
⤷ performance_group_id searchable	Integer	Unique ID of the performance group
⤷ performance_group_name searchable	String	Unique name of the performance group.
⤷ performance_group_enabled	Boolean
⤷ performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
⤷ performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
⤷ adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
⤷ amz_portfolio_id searchable	LargeInteger
⤷ amz_portfolio_name searchable	String
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id searchable	LargeInteger
⤷ campaign_name searchable	String
⤷ campaign_type	CampaignType
⤷ campaign_eby_marketplace_id	String
⤷ campaign_status	CampaignStatus
⤷ campaign_optimize	Boolean
⤷ campaign_optimization_type	OptimizationType
⤷ campaign_optimization_support	CampaignOptimizationSupport
⤷ campaign_labels searchable	[ String ]
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_id searchable	LargeInteger
⤷ adgroup_name searchable	String
⤷ adgroup_status	AdgroupStatus
⤷ adgroup_labels searchable	[ String ]
metrics	Object
⤷ cost	Micros
⤷ impressions	Integer
⤷ clicks	Integer
⤷ conversions	Float
⤷ profit_gross	Micros	Gross profit
⤷ profit_net	Micros	Net profit. profit_gross - cost
⤷ revenue	Micros	Revenue/sales
⤷ cost_per_click	Micros	Effective CPC. cost / clicks NULL if number of clicks is 0.
⤷ cost_per_conversion	Micros	Cost per conversion. cost / conversions NULL if number of conversions is 0.
⤷ revenue_per_conversion	Micros	Revenue per conversions. revenue / conversions
⤷ conversion_rate	Float	Conversion rate. conversions / clicks NULL if number of clicks is 0.
⤷ click_through_rate	Float	Clickthrough rate (CTR). clicks / impressions NULL if number of impressions is 0.
⤷ return_on_investment	Float	Return on investment (ROI). profit_gross / cost NULL if cost is 0.
⤷ return_on_ad_spend	Float	Return on ad spend (ROAS). revenue / cost NULL if cost is 0.
⤷ cost_revenue_ratio	Float	Cost Revenue Ratio (CRR). Also called Advertising Cost of Sale (ACoS). cost / revenue NULL if revenue is 0.
rule_snapshots	[ Object ]
⤷ rule_snapshot_id	LargeInteger	Id of the rule snapshot.
⤷ rule_id	LargeInteger	Id of the rule that this snapshot was created for.
⤷ action	CriterionAdditionRuleAction	Rule action at the time that the snapshot was generated.
⤷ filters	[ Object ]	Rule filters at the time that the snapshot was generated.
⤷ operand	CriterionAdditionRuleFilterOperand	Rule filter operand.
⤷ operation	CriterionAdditionRuleFilterOperation	Rule filter operation.
⤷ values	[ Any ]	Rule filter values.
⤷ catch_all	Boolean	Rule catch_all value at the time that the snapshot was generated.
⤷ defined_at	Object	Extra information about the location where snapshotted rule was defined at.
⤷ level	CriterionAdditionRuleLevel
⤷ platform	AdPlatform
⤷ adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
⤷ account_id searchable	String	Ad platform specific ID of an advertising account.
⤷ account_name searchable	String
⤷ account_platform	AdPlatform	The account’s advertising platform.
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id searchable	LargeInteger
⤷ campaign_name searchable	String
⤷ campaign_type	CampaignType
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_id searchable	LargeInteger
⤷ adgroup_name searchable	String
destinations	[ Object ]
⤷ destination_id	LargeInteger
⤷ state	CriterionAdditionDestinationState	State of the proposal destination.
⤷ rule_snapshot_id	LargeInteger	Id of the snapshot of the rule that defined current destination. NULL if destination had been created by the user.
⤷ destination_type	CriterionAdditionDestinationType
⤷ selected_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Id of an explicitly selected destination adgroup. This field is populated only for SELECTED-ADGROUP destinations and is NULL for all other destination types. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ match_type	CriterionAdditionMatchType	Keyword match type. This field is populated only for destinations that belong to proposals where criterion_type is KEYWORD.
⤷ negative	Boolean	Is the criterion created for this destination supposed to be negative?
⤷ effective_destination	Object	Details about the effective destination adgroup. Can be NULL for some destination types, if the adgroup hasn’t yet been created.
⤷ performance_group_id searchable	Integer	Unique ID of the performance group
⤷ performance_group_name searchable	String	Unique name of the performance group.
⤷ performance_group_enabled	Boolean
⤷ performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
⤷ performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
⤷ adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
⤷ amz_portfolio_id searchable	LargeInteger
⤷ amz_portfolio_name searchable	String
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id searchable	LargeInteger
⤷ campaign_name searchable	String
⤷ campaign_type	CampaignType
⤷ campaign_eby_marketplace_id	String
⤷ campaign_status	CampaignStatus
⤷ campaign_optimize	Boolean
⤷ campaign_optimization_type	OptimizationType
⤷ campaign_optimization_support	CampaignOptimizationSupport
⤷ campaign_labels searchable	[ String ]
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_id searchable	LargeInteger
⤷ adgroup_name searchable	String
⤷ adgroup_status	AdgroupStatus
⤷ adgroup_labels searchable	[ String ]
⤷ warnings	[ Object ]	Destination warnings.
⤷ warning_type	CriterionAdditionDestinationWarningType	Destination warning type.
⤷ context	Dict	Extra information about the warning. Not all warning types support this extra information.
⤷ critical	Boolean	Is the warning critical? Critical warnings mean that the destination cannot be created. Non-critical warnings allow the destination to be created and simply serve as extra information about potential isues with the destination.

Example

http

GET /v3/customers/7027038674/criterion-addition/proposals?filter_profit_gross_ge=7910000&filter_destination_performance_group_enabled=True&sort_account_name=5 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/proposals?filter_profit_gross_ge=7910000&filter_destination_performance_group_enabled=True&sort_account_name=5' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/proposals?filter_profit_gross_ge=7910000&filter_destination_performance_group_enabled=True&sort_account_name=5' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/criterion-addition/proposals?filter_profit_gross_ge=7910000&filter_destination_performance_group_enabled=True&sort_account_name=5', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "proposal_id": "55669895173420790989137281",
      "rule_type_id": 5675219470,
      "proposal_type": "ADDITION",
      "proposal_reasons": [
        "CHEAP-CLICK"
      ],
      "proposal_state": "ACCEPTED",
      "criterion_type": "KEYWORD",
      "criterion_subtype": "ASIN",
      "criterion_name": "dolor adlora",
      "forced_review_reasons": [
        "INVALID-DESTINATIONS"
      ],
      "source": {
        "adspert_account_id": 123,
        "account_id": "amet lorem",
        "account_name": "vehicula ipsum",
        "account_platform": "AMAZON",
        "account_optimize": true,
        "account_tags_user": [
          "vehicula amet"
        ],
        "account_is_demo": true,
        "performance_group_id": "1245",
        "performance_group_name": "dolor sit",
        "performance_group_enabled": true,
        "performance_group_optimization_type": "CLICK",
        "performance_group_goals": [
          {
            "goal_type": "CLICKS-PER-DAY",
            "goal_value": 1.41,
            "goal_currency": "AED",
            "goal_micros": 6300000,
            "goal_ratio": 8.77
          }
        ],
        "performance_group_goal_types": [
          "CLICKS-PER-DAY"
        ],
        "adspert_portfolio_id": "123:9999",
        "amz_portfolio_id": "9999",
        "amz_portfolio_name": "elit adlora",
        "adspert_campaign_id": "123:5555",
        "campaign_id": "5555",
        "campaign_name": "sit ipsum",
        "campaign_type": "AMAZON-SPONSORED-BRANDS",
        "campaign_eby_marketplace_id": "amet pariatur",
        "campaign_status": "ACTIVE",
        "campaign_optimize": true,
        "campaign_optimization_type": "CLICK",
        "campaign_optimization_support": "SUPPORTED",
        "campaign_labels": [
          "ipsum dolor"
        ],
        "adspert_adgroup_id": "123:777",
        "adgroup_id": "777",
        "adgroup_name": "tucan lorem",
        "adgroup_status": "ACTIVE",
        "adgroup_labels": [
          "elit ipsum"
        ]
      },
      "metrics": {
        "cost": 4540000,
        "impressions": 2157218327,
        "clicks": 5857268080,
        "conversions": 3.92,
        "profit_gross": 6420000,
        "profit_net": 30000,
        "revenue": 360000,
        "cost_per_click": 7300000,
        "cost_per_conversion": 7570000,
        "revenue_per_conversion": 7070000,
        "conversion_rate": 0.86,
        "click_through_rate": 7.58,
        "return_on_investment": 3.28,
        "return_on_ad_spend": 2.29,
        "cost_revenue_ratio": 16.41
      },
      "rule_snapshots": [
        {
          "rule_snapshot_id": "29900904027622664405022614",
          "rule_id": "49754540226638646583189955",
          "action": "ADD",
          "filters": [
            {
              "operand": "DOMAIN",
              "operation": "CONTAINS",
              "values": [
                1
              ]
            }
          ],
          "catch_all": true,
          "defined_at": {
            "level": "ACCOUNT",
            "platform": "AMAZON",
            "adspert_account_id": 123,
            "account_id": "amet lorem",
            "account_name": "vehicula ipsum",
            "account_platform": "AMAZON",
            "adspert_campaign_id": "123:5555",
            "campaign_id": "5555",
            "campaign_name": "sit ipsum",
            "campaign_type": "AMAZON-SPONSORED-BRANDS",
            "adspert_adgroup_id": "123:777",
            "adgroup_id": "777",
            "adgroup_name": "tucan lorem"
          }
        }
      ],
      "destinations": [
        {
          "destination_id": "78046413193991906103940983",
          "state": "ACCEPTED",
          "rule_snapshot_id": "29900904027622664405022614",
          "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
          "selected_adgroup_id": "123:777",
          "match_type": "BROAD",
          "negative": true,
          "effective_destination": {
            "performance_group_id": "1245",
            "performance_group_name": "dolor sit",
            "performance_group_enabled": true,
            "performance_group_optimization_type": "CLICK",
            "performance_group_goals": [
              {
                "goal_type": "CLICKS-PER-DAY",
                "goal_value": 1.41,
                "goal_currency": "AED",
                "goal_micros": 6300000,
                "goal_ratio": 8.77
              }
            ],
            "performance_group_goal_types": [
              "CLICKS-PER-DAY"
            ],
            "adspert_portfolio_id": "123:9999",
            "amz_portfolio_id": "9999",
            "amz_portfolio_name": "elit adlora",
            "adspert_campaign_id": "123:5555",
            "campaign_id": "5555",
            "campaign_name": "sit ipsum",
            "campaign_type": "AMAZON-SPONSORED-BRANDS",
            "campaign_eby_marketplace_id": "amet pariatur",
            "campaign_status": "ACTIVE",
            "campaign_optimize": true,
            "campaign_optimization_type": "CLICK",
            "campaign_optimization_support": "SUPPORTED",
            "campaign_labels": [
              "ipsum dolor"
            ],
            "adspert_adgroup_id": "123:777",
            "adgroup_id": "777",
            "adgroup_name": "tucan lorem",
            "adgroup_status": "ACTIVE",
            "adgroup_labels": [
              "elit ipsum"
            ]
          },
          "warnings": [
            {
              "warning_type": "ACCOUNT-TOO-MANY-ADGROUPS",
              "context": {
                "adlora pariatur": 1
              },
              "critical": true
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "proposal_id": 1
      }
    }
  }
}

PATCH

PATCH /v3/customers/(customer_id: int)/criterion-addition/proposals

Update criterion addition proposals.

Auth mode:

api-token

Access level:

user

Request Data (object list, json)

Name	Type	Description
proposal_id required	LargeInteger	Unique ID of the proposal.
proposal_state	CriterionAdditionProposalState	State of the proposal.
destinations	[ Object ]	Proposal destinations. This field should be skipped (or set to NULL) when proposal_state is set to REJECTED or REVIEW. This field is required (with at least one destination) when proposal_state is set to ACCEPTED.
⤷ destination_type required	CriterionAdditionDestinationType	Type of the destination.
⤷ selected_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Id of an explicitly selected destination adgroup. This field is required for SELECTED-ADGROUP destinations and should be NULL for any other destination type. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ match_type	CriterionAdditionMatchType	Keyword match type. This field is required for destinations that belong to proposals where criterion_type is KEYWORD.
⤷ negative required	Boolean	Is the criterion created for this destination supposed to be negative?
validate_only	Boolean	If set to True PATCH requests will only be validated, and will not (after successful validation) be saved. Default value is False.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
unchanged	[ Object ]	List of objects which had no effective change.
⤷ proposal_id	LargeInteger	See request data description.
⤷ proposal_state	CriterionAdditionProposalState	See request data description.
⤷ destinations	[ Object ]	See request data description.
⤷ destination_type	CriterionAdditionDestinationType	See request data description.
⤷ selected_adgroup_id	CompositeID	See request data description.
⤷ match_type	CriterionAdditionMatchType	See request data description.
⤷ negative	Boolean	See request data description.
⤷ validate_only	Boolean	See request data description.
unknown	[ Object ]	List of objects which could not be found.
⤷ proposal_id	LargeInteger	See request data description.
⤷ proposal_state	CriterionAdditionProposalState	See request data description.
⤷ destinations	[ Object ]	See request data description.
⤷ destination_type	CriterionAdditionDestinationType	See request data description.
⤷ selected_adgroup_id	CompositeID	See request data description.
⤷ match_type	CriterionAdditionMatchType	See request data description.
⤷ negative	Boolean	See request data description.
⤷ validate_only	Boolean	See request data description.
updated	[ Object ]	List of objects which have been updated.
⤷ proposal_id	LargeInteger	See request data description.
⤷ proposal_state	CriterionAdditionProposalState	See request data description.
⤷ destinations	[ Object ]	See request data description.
⤷ destination_type	CriterionAdditionDestinationType	See request data description.
⤷ selected_adgroup_id	CompositeID	See request data description.
⤷ match_type	CriterionAdditionMatchType	See request data description.
⤷ negative	Boolean	See request data description.
⤷ validate_only	Boolean	See request data description.

Example

http

PATCH /v3/customers/7027038674/criterion-addition/proposals HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "proposal_id": "55669895173420790989137281",
    "proposal_state": "ACCEPTED",
    "destinations": [
      {
        "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
        "selected_adgroup_id": "123:777",
        "match_type": "BROAD",
        "negative": true
      }
    ],
    "validate_only": true
  }
]

curl

curl -i -X PATCH https://api.adspert.net/v3/customers/7027038674/criterion-addition/proposals -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"proposal_id": "55669895173420790989137281", "proposal_state": "ACCEPTED", "destinations": [{"destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP", "selected_adgroup_id": "123:777", "match_type": "BROAD", "negative": true}], "validate_only": true}]'

httpie

echo '[
  {
    "destinations": [
      {
        "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
        "match_type": "BROAD",
        "negative": true,
        "selected_adgroup_id": "123:777"
      }
    ],
    "proposal_id": "55669895173420790989137281",
    "proposal_state": "ACCEPTED",
    "validate_only": true
  }
]' | http PATCH https://api.adspert.net/v3/customers/7027038674/criterion-addition/proposals Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.patch('https://api.adspert.net/v3/customers/7027038674/criterion-addition/proposals', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'proposal_id': '55669895173420790989137281', 'proposal_state': 'ACCEPTED', 'destinations': [{'destination_type': 'AMAZON-CREATE-BRAND-KEYWORD-ADGROUP', 'selected_adgroup_id': '123:777', 'match_type': 'BROAD', 'negative': True}], 'validate_only': True}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "unchanged": [
      {
        "proposal_id": "55669895173420790989137281",
        "proposal_state": "ACCEPTED",
        "destinations": [
          {
            "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
            "selected_adgroup_id": "123:777",
            "match_type": "BROAD",
            "negative": true
          }
        ],
        "validate_only": true
      }
    ],
    "unknown": [
      {
        "proposal_id": "55669895173420790989137281",
        "proposal_state": "ACCEPTED",
        "destinations": [
          {
            "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
            "selected_adgroup_id": "123:777",
            "match_type": "BROAD",
            "negative": true
          }
        ],
        "validate_only": true
      }
    ],
    "updated": [
      {
        "proposal_id": "55669895173420790989137281",
        "proposal_state": "ACCEPTED",
        "destinations": [
          {
            "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
            "selected_adgroup_id": "123:777",
            "match_type": "BROAD",
            "negative": true
          }
        ],
        "validate_only": true
      }
    ]
  },
  "meta": {}
}

SettingsCollection

GET

GET /v3/customers/(customer_id: int)/criterion-addition/settings

Retrieve Criterion Addition settings.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_level required	CriterionAdditionSettingLevel
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_setting_type	[ CriterionAdditionSettingType ]	Only return results matching given setting_type values.
filter_setting_value	[ String ]	Only return results matching given setting_value values.
filter_setting_value_inherited	[ Boolean ]	Only return results matching given setting_value_inherited values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_is_demo	SortDirective	Sort results by account_is_demo.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_optimize	SortDirective	Sort results by account_optimize.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
setting_type	CriterionAdditionSettingType	Type of the setting
setting_value_type	CriterionAdditionSettingValueType	Type of the setting value. It’s a data type that the setting_value should be casted to.
setting_value	String	All setting values are returned as strings and should be casted to a proper type (setting_value_type) by the client.
setting_value_inherited	Boolean	Was the setting value defined at the account-level or inherited from the customer-level? Always false for customer-level settings.
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account NULL for customer-level settings.
account_id searchable	String	Ad platform specific ID of an advertising account. NULL for customer-level settings.
account_name searchable	String	NULL for customer-level settings.
account_platform	AdPlatform	The account’s advertising platform. NULL for customer-level settings.
account_optimize	Boolean	If optimization by Adspert is enabled for this account. NULL for customer-level settings.
account_tags_user searchable	[ String ]	NULL for customer-level settings.
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform. NULL for customer-level settings.

Example

http

GET /v3/customers/7027038674/criterion-addition/settings?filter_setting_type=ENFORCE-ADVANCED-MODE&search_adspert_account_id=dolor+vehicula&search_account_tags_user=dolor+elit HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/settings?filter_setting_type=ENFORCE-ADVANCED-MODE&search_adspert_account_id=dolor+vehicula&search_account_tags_user=dolor+elit' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/settings?filter_setting_type=ENFORCE-ADVANCED-MODE&search_adspert_account_id=dolor+vehicula&search_account_tags_user=dolor+elit' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/criterion-addition/settings?filter_setting_type=ENFORCE-ADVANCED-MODE&search_adspert_account_id=dolor+vehicula&search_account_tags_user=dolor+elit', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "setting_type": "ENFORCE-ADVANCED-MODE",
      "setting_value_type": "BOOLEAN",
      "setting_value": "elit pariatur",
      "setting_value_inherited": true,
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "account_optimize": true,
      "account_tags_user": [
        "vehicula amet"
      ],
      "account_is_demo": true
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "setting_type": 1
      }
    }
  }
}

PATCH

PATCH /v3/customers/(customer_id: int)/criterion-addition/settings

Update Criterion Addition settings.

Auth mode:

api-token

Access level:

user

Request Data (object list, json or csv)

Name	Type	Description
adspert_account_id	Integer	Should be set to NULL for customer-level settings. Should be set to a non-NULL value for account-level settings.
setting_type required	CriterionAdditionSettingType	Type of the setting
setting_value required	String	Setting value as string

Response Data (single object, json or csv or xlsx)

Name	Type	Description
unchanged	[ Object ]	List of objects which had no effective change.
⤷ adspert_account_id	Integer	See request data description.
⤷ setting_type	CriterionAdditionSettingType	See request data description.
⤷ setting_value	String	See request data description.
unknown	[ Object ]	List of objects which could not be found.
⤷ adspert_account_id	Integer	See request data description.
⤷ setting_type	CriterionAdditionSettingType	See request data description.
⤷ setting_value	String	See request data description.
updated	[ Object ]	List of objects which have been updated.
⤷ adspert_account_id	Integer	See request data description.
⤷ setting_type	CriterionAdditionSettingType	See request data description.
⤷ setting_value	String	See request data description.

Example

http

PATCH /v3/customers/7027038674/criterion-addition/settings HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "adspert_account_id": 123,
    "setting_type": "ENFORCE-ADVANCED-MODE",
    "setting_value": "elit pariatur"
  }
]

curl

curl -i -X PATCH https://api.adspert.net/v3/customers/7027038674/criterion-addition/settings -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"adspert_account_id": 123, "setting_type": "ENFORCE-ADVANCED-MODE", "setting_value": "elit pariatur"}]'

httpie

echo '[
  {
    "adspert_account_id": 123,
    "setting_type": "ENFORCE-ADVANCED-MODE",
    "setting_value": "elit pariatur"
  }
]' | http PATCH https://api.adspert.net/v3/customers/7027038674/criterion-addition/settings Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.patch('https://api.adspert.net/v3/customers/7027038674/criterion-addition/settings', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'adspert_account_id': 123, 'setting_type': 'ENFORCE-ADVANCED-MODE', 'setting_value': 'elit pariatur'}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "unchanged": [
      {
        "adspert_account_id": 123,
        "setting_type": "ENFORCE-ADVANCED-MODE",
        "setting_value": "elit pariatur"
      }
    ],
    "unknown": [
      {
        "adspert_account_id": 123,
        "setting_type": "ENFORCE-ADVANCED-MODE",
        "setting_value": "elit pariatur"
      }
    ],
    "updated": [
      {
        "adspert_account_id": 123,
        "setting_type": "ENFORCE-ADVANCED-MODE",
        "setting_value": "elit pariatur"
      }
    ]
  },
  "meta": {}
}

RuleTypeCollection

GET

GET /v3/customers/(customer_id: int)/criterion-addition/rule-types

Get available Criterion Addition rule types.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_campaign_type	[ CriterionAdditionRuleCampaignType ]	Only return results matching given campaign_type values.
filter_criterion_subtype	[ CriterionAdditionCriterionSubtype ]	Only return results matching given criterion_subtype values.
filter_criterion_type	[ CriterionAdditionCriterionType ]	Only return results matching given criterion_type values.
filter_enabled	[ Boolean ]	Only return results matching given enabled values.
filter_platform	[ AdPlatform ]	Only return results matching given platform values.
filter_proposal_type	[ CriterionAdditionProposalType ]	Only return results matching given proposal_type values.
filter_rule_type_id	[ Integer ]	Only return results matching given rule_type_id values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_criterion_subtype	SortDirective	Sort results by criterion_subtype.
sort_criterion_type	SortDirective	Sort results by criterion_type.
sort_enabled	SortDirective	Sort results by enabled.
sort_platform	SortDirective	Sort results by platform.
sort_proposal_type	SortDirective	Sort results by proposal_type.
sort_rule_type_id	SortDirective	Sort results by rule_type_id.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
rule_type_id	Integer	Unique Rule Type ID.
platform	AdPlatform	Platform that the Rule Type is defined for.
campaign_type	CriterionAdditionRuleCampaignType	Type of campaigns that the Rule Type is defined for.
proposal_type	CriterionAdditionProposalType	Type of proposals that the Rule Type is defined for.
criterion_type	CriterionAdditionCriterionType	Type of criteria that the Rule Type is defined for.
criterion_subtype	CriterionAdditionCriterionSubtype	Subtype of criteria that the Rule Type is defined for.
enabled	Boolean	Is the rule type enabled? Rules that belong to a disabled Rule Type, won’t generate any proposals.

Example

http

GET /v3/customers/7027038674/criterion-addition/rule-types?sort_proposal_type=7&sort_rule_type_id=0&exclude=elit.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/rule-types?sort_proposal_type=7&sort_rule_type_id=0&exclude=elit.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/rule-types?sort_proposal_type=7&sort_rule_type_id=0&exclude=elit.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/criterion-addition/rule-types?sort_proposal_type=7&sort_rule_type_id=0&exclude=elit.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "rule_type_id": 5675219470,
      "platform": "AMAZON",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "proposal_type": "ADDITION",
      "criterion_type": "KEYWORD",
      "criterion_subtype": "ASIN",
      "enabled": true
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "rule_type_id": 1
      }
    }
  }
}

DestinationAdGroupCollection

GET

GET /v3/customers/(customer_id: int)/criterion-addition/destination-adgroups

Get adgroups, evaluated for usage as a rule / proposal destination

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_adgroup_labels	[ String ]	Only return results matching given adgroup_labels values.
filter_adgroup_name	[ String ]	Only return results matching given adgroup_name values.
filter_adgroup_status	[ AdgroupStatus ]	Only return results matching given adgroup_status values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_adspert_adgroup_id	[ CompositeID ]	Only return results matching given adspert_adgroup_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_adgroup_id	String	Only return results where adgroup_id matches the given string.
search_adgroup_labels	String	Only return results where adgroup_labels matches the given string.
search_adgroup_name	String	Only return results where adgroup_name matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_is_demo	SortDirective	Sort results by account_is_demo.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_optimize	SortDirective	Sort results by account_optimize.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adgroup_id	SortDirective	Sort results by adgroup_id.
sort_adgroup_name	SortDirective	Sort results by adgroup_name.
sort_adgroup_status	SortDirective	Sort results by adgroup_status.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_adspert_adgroup_id	SortDirective	Sort results by adspert_adgroup_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_support	SortDirective	Sort results by campaign_optimization_support.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_status	SortDirective	Sort results by campaign_status.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_destination_enabled	SortDirective	Sort results by destination_enabled.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1
rule_type_id	Integer	Type of the rule to get the destination adgroups for. If rule_type_id is specified, rule_adspert_adgroup_id must be included as well.
rule_adspert_adgroup_id	CompositeID	Required when rule_type_id is set. Composite ID specification: {adspert_account_id}:{adgroup_id}
proposal_id	LargeInteger	Id of the proposal to get the destination adgroups for. If proposal_id is specified , none of the rule_ prefixed query params should be included.

Response Data (object list, json or csv or xlsx)

Name	Type	Description
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_id searchable	String	Ad platform specific ID of an advertising account.
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
account_optimize	Boolean	If optimization by Adspert is enabled for this account.
account_tags_user searchable	[ String ]
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
performance_group_id searchable	Integer	Unique ID of the performance group
performance_group_name searchable	String	Unique name of the performance group.
performance_group_enabled	Boolean
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger
amz_portfolio_name searchable	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger
campaign_name searchable	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_status	CampaignStatus
campaign_optimize	Boolean
campaign_optimization_type	OptimizationType
campaign_optimization_support	CampaignOptimizationSupport
campaign_labels searchable	[ String ]
adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
adgroup_id searchable	LargeInteger
adgroup_name searchable	String
adgroup_status	AdgroupStatus
adgroup_labels searchable	[ String ]
destination_options	[ Object ]	Destination options for each combination of match_type and negative flag.
⤷ match_type	CriterionAdditionMatchType	Keyword match type. NULL for rules/proposals where criterion_type is not KEYWORD.
⤷ negative	Boolean	Is the criterion negative?
⤷ warnings	[ Object ]	Destination warnings. Lack of warnings means that the given option can be used as a destination in the requested proposal / rule.
⤷ warning_type	CriterionAdditionDestinationWarningType	Destination warning type.
⤷ context	Dict	Extra information about the warning. Not all warning types support this extra information.
⤷ critical	Boolean	Is the warning critical? Critical warnings mean that the destination cannot be created. Non-critical warnings allow the destination to be created and simply serve as extra information about potential isues with the destination.
destination_enabled	Boolean	Indicates if the destination is enabled. This can only be the case if at least one destination option has no critical warning.
is_limited_selection	Boolean	Indicates if we had to limit the number of AdGroups that we are validating.

Example

http

GET /v3/customers/7027038674/criterion-addition/destination-adgroups?sort_campaign_id=9&filter_campaign_labels=ipsum+dolor&filter_performance_group_goal_types=CLICKS-PER-DAY HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/destination-adgroups?sort_campaign_id=9&filter_campaign_labels=ipsum+dolor&filter_performance_group_goal_types=CLICKS-PER-DAY' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/destination-adgroups?sort_campaign_id=9&filter_campaign_labels=ipsum+dolor&filter_performance_group_goal_types=CLICKS-PER-DAY' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/criterion-addition/destination-adgroups?sort_campaign_id=9&filter_campaign_labels=ipsum+dolor&filter_performance_group_goal_types=CLICKS-PER-DAY', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "account_optimize": true,
      "account_tags_user": [
        "vehicula amet"
      ],
      "account_is_demo": true,
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_enabled": true,
      "performance_group_optimization_type": "CLICK",
      "performance_group_goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "campaign_eby_marketplace_id": "amet pariatur",
      "campaign_status": "ACTIVE",
      "campaign_optimize": true,
      "campaign_optimization_type": "CLICK",
      "campaign_optimization_support": "SUPPORTED",
      "campaign_labels": [
        "ipsum dolor"
      ],
      "adspert_adgroup_id": "123:777",
      "adgroup_id": "777",
      "adgroup_name": "tucan lorem",
      "adgroup_status": "ACTIVE",
      "adgroup_labels": [
        "elit ipsum"
      ],
      "destination_options": [
        {
          "match_type": "BROAD",
          "negative": true,
          "warnings": [
            {
              "warning_type": "ACCOUNT-TOO-MANY-ADGROUPS",
              "context": {
                "adlora pariatur": 1
              },
              "critical": true
            }
          ]
        }
      ],
      "destination_enabled": true,
      "is_limited_selection": true
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "adspert_account_id": 1
      }
    }
  }
}

DestinationTypeCollection

GET

GET /v3/customers/(customer_id: int)/criterion-addition/destination-types

Get rule / proposal destination types.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
rule_type_id	Integer	Type of the rule to get the destination types for. If rule_type_id is specified, rule_level must be included as well.
rule_level	CriterionAdditionRuleLevel	Level of the rule to get the destination types for. If set to ACCOUNT, rule_adspert_account_id must be specified. If set to CAMPAIGN, rule_adspert_campaign_id must be specified. If set to ADGROUP, rule_adspert_adgroup_id must be specified.
rule_adspert_account_id	Integer	Required when rule_level is set to ACCOUNT.
rule_adspert_campaign_id	CompositeID	Required when rule_level is set to CAMPAIGN. Composite ID specification: {adspert_account_id}:{campaign_id}
rule_adspert_adgroup_id	CompositeID	Required when rule_level is set to ADGROUP. Composite ID specification: {adspert_account_id}:{adgroup_id}
proposal_id	LargeInteger	Id of the proposal to get the destination types for. If proposal_id is specified , none of the rule_ prefixed query params should be included.

Response Data (object list, json or csv or xlsx)

Name	Type	Description
destination_type	CriterionAdditionDestinationType	Type of rule / proposal destination.
allowed	Boolean	Is the destination type allowed for the requested rule / proposal? Checking options can be skipped if allowed` is set to false, as all of them will be marked as not allowed.
destination_options	[ Object ]	Destination options for each combination of match_type and negative flag.
⤷ match_type	CriterionAdditionMatchType	Keyword match type. NULL for rules/proposals where criterion_type is not KEYWORD.
⤷ negative	Boolean	Is the criterion negative?
⤷ warnings	[ Object ]	Destination warnings. Lack of warnings means that the given option can be used as a destination in the requested proposal / rule.
⤷ warning_type	CriterionAdditionDestinationWarningType	Destination warning type.
⤷ context	Dict	Extra information about the warning. Not all warning types support this extra information.
⤷ critical	Boolean	Is the warning critical? Critical warnings mean that the destination cannot be created. Non-critical warnings allow the destination to be created and simply serve as extra information about potential isues with the destination.

Example

http

GET /v3/customers/7027038674/criterion-addition/destination-types?rule_adspert_adgroup_id=123%3A777&proposal_id=55669895173420790989137281&include=ipsum.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/destination-types?rule_adspert_adgroup_id=123%3A777&proposal_id=55669895173420790989137281&include=ipsum.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/destination-types?rule_adspert_adgroup_id=123%3A777&proposal_id=55669895173420790989137281&include=ipsum.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/criterion-addition/destination-types?rule_adspert_adgroup_id=123%3A777&proposal_id=55669895173420790989137281&include=ipsum.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
      "allowed": true,
      "destination_options": [
        {
          "match_type": "BROAD",
          "negative": true,
          "warnings": [
            {
              "warning_type": "ACCOUNT-TOO-MANY-ADGROUPS",
              "context": {
                "adlora pariatur": 1
              },
              "critical": true
            }
          ]
        }
      ]
    }
  ],
  "meta": {}
}

Product Ad Sync

ProductAdSyncTargetsCollection

GET

GET /v3/customers/(customer_id: int)/product-ax/sync-targets

Get product ad sync targets.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_account_currency	[ String ]	Only return results matching given account_currency values.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_adgroup_labels	[ String ]	Only return results matching given adgroup_labels values.
filter_adgroup_name	[ String ]	Only return results matching given adgroup_name values.
filter_adgroup_status	[ AdgroupStatus ]	Only return results matching given adgroup_status values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_adspert_adgroup_id	[ CompositeID ]	Only return results matching given adspert_adgroup_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
filter_target_adgroup_labels	[ String ]	Only return results matching given targets.adgroup_labels values.
filter_target_adgroup_name	[ String ]	Only return results matching given targets.adgroup_name values.
filter_target_adgroup_status	[ AdgroupStatus ]	Only return results matching given targets.adgroup_status values.
filter_target_adspert_adgroup_id	[ CompositeID ]	Only return results matching given targets.adspert_adgroup_id values.
filter_target_adspert_campaign_id	[ CompositeID ]	Only return results matching given targets.adspert_campaign_id values.
filter_target_adspert_portfolio_id	[ CompositeID ]	Only return results matching given targets.adspert_portfolio_id values.
filter_target_amz_portfolio_name	[ String ]	Only return results matching given targets.amz_portfolio_name values.
filter_target_campaign_eby_marketplace_id	[ String ]	Only return results matching given targets.campaign_eby_marketplace_id values.
filter_target_campaign_labels	[ String ]	Only return results matching given targets.campaign_labels values.
filter_target_campaign_name	[ String ]	Only return results matching given targets.campaign_name values.
filter_target_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given targets.campaign_optimization_support values.
filter_target_campaign_optimization_type	[ OptimizationType ]	Only return results matching given targets.campaign_optimization_type values.
filter_target_campaign_optimize	[ Boolean ]	Only return results matching given targets.campaign_optimize values.
filter_target_campaign_type	[ CampaignType ]	Only return results matching given targets.campaign_type values.
filter_target_performance_group_enabled	[ Boolean ]	Only return results matching given targets.performance_group_enabled values.
filter_target_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given targets.performance_group_goal_types values.
filter_target_performance_group_id	[ Integer ]	Only return results matching given targets.performance_group_id values.
filter_target_performance_group_name	[ String ]	Only return results matching given targets.performance_group_name values.
filter_target_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given targets.performance_group_optimization_type values.
filter_target_read_only	[ Boolean ]	Only return results matching given targets.read_only values.
filter_target_sync_mode	[ ApiEnumSyncMode ]	Only return results matching given targets.sync_mode values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_adgroup_id	String	Only return results where adgroup_id matches the given string.
search_adgroup_labels	String	Only return results where adgroup_labels matches the given string.
search_adgroup_name	String	Only return results where adgroup_name matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
search_target_adgroup_id	String	Only return results where targets.adgroup_id matches the given string.
search_target_adgroup_labels	String	Only return results where targets.adgroup_labels matches the given string.
search_target_adgroup_name	String	Only return results where targets.adgroup_name matches the given string.
search_target_amz_portfolio_id	String	Only return results where targets.amz_portfolio_id matches the given string.
search_target_amz_portfolio_name	String	Only return results where targets.amz_portfolio_name matches the given string.
search_target_campaign_id	String	Only return results where targets.campaign_id matches the given string.
search_target_campaign_labels	String	Only return results where targets.campaign_labels matches the given string.
search_target_campaign_name	String	Only return results where targets.campaign_name matches the given string.
search_target_performance_group_id	String	Only return results where targets.performance_group_id matches the given string.
search_target_performance_group_name	String	Only return results where targets.performance_group_name matches the given string.
sort_account_currency	SortDirective	Sort results by account_currency.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_is_demo	SortDirective	Sort results by account_is_demo.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_optimize	SortDirective	Sort results by account_optimize.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adgroup_id	SortDirective	Sort results by adgroup_id.
sort_adgroup_name	SortDirective	Sort results by adgroup_name.
sort_adgroup_status	SortDirective	Sort results by adgroup_status.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_adspert_adgroup_id	SortDirective	Sort results by adspert_adgroup_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_support	SortDirective	Sort results by campaign_optimization_support.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
sort_target_read_only	SortDirective	Sort results by targets.read_only.
sort_target_sync_mode	SortDirective	Sort results by targets.sync_mode.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_id searchable	String	Ad platform specific ID of an advertising account.
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
account_optimize	Boolean	If optimization by Adspert is enabled for this account.
account_currency	String
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
account_tags_user searchable	[ String ]
adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
adgroup_id searchable	LargeInteger
adgroup_name searchable	String
adgroup_status	AdgroupStatus
adgroup_labels searchable	[ String ]
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger
campaign_name searchable	String
campaign_type	CampaignType
campaign_optimize	Boolean
campaign_labels searchable	[ String ]
campaign_optimization_type	OptimizationType
campaign_optimization_support	CampaignOptimizationSupport
campaign_eby_marketplace_id	String
performance_group_id searchable	Integer	Unique ID of the performance group
performance_group_name searchable	String	Unique name of the performance group.
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_enabled	Boolean
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger
amz_portfolio_name searchable	String
targets	[ Object ]	Details about the target AdGroups which the Product Ads are being synced to. [] if the AdGroup isn’t yet being synced.
⤷ adgroup_id searchable	LargeInteger
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_name searchable	String	When including this field in search_fields, use targets.adgroup_name
⤷ adgroup_status	AdgroupStatus
⤷ adgroup_labels searchable	[ String ]	When including this field in search_fields, use targets.adgroup_labels
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id searchable	LargeInteger
⤷ campaign_name searchable	String	When including this field in search_fields, use targets.campaign_name
⤷ campaign_type	CampaignType
⤷ campaign_optimize	Boolean
⤷ campaign_labels searchable	[ String ]	When including this field in search_fields, use targets.campaign_labels
⤷ campaign_optimization_type	OptimizationType
⤷ campaign_optimization_support	CampaignOptimizationSupport
⤷ campaign_eby_marketplace_id	String
⤷ performance_group_id searchable	Integer	Unique ID of the performance group
⤷ performance_group_name searchable	String	Unique name of the performance group. When including this field in search_fields, use targets.performance_group_name
⤷ performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
⤷ performance_group_enabled	Boolean
⤷ performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
⤷ adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
⤷ amz_portfolio_id searchable	LargeInteger
⤷ amz_portfolio_name searchable	String	When including this field in search_fields, use targets.amz_portfolio_name
⤷ sync_mode	ApiEnumSyncMode	Mode of the product ad sync.
⤷ read_only	Boolean	Indicates if the target AdGroup can be modified.

Example

http

GET /v3/customers/7027038674/product-ax/sync-targets?sort_target_sync_mode=7&filter_target_performance_group_name=dolor+sit&filter_target_adspert_adgroup_id=123%3A13 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/product-ax/sync-targets?sort_target_sync_mode=7&filter_target_performance_group_name=dolor+sit&filter_target_adspert_adgroup_id=123%3A13' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/product-ax/sync-targets?sort_target_sync_mode=7&filter_target_performance_group_name=dolor+sit&filter_target_adspert_adgroup_id=123%3A13' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/product-ax/sync-targets?sort_target_sync_mode=7&filter_target_performance_group_name=dolor+sit&filter_target_adspert_adgroup_id=123%3A13', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "account_optimize": true,
      "account_currency": "ipsum adlora",
      "account_is_demo": true,
      "account_tags_user": [
        "vehicula amet"
      ],
      "adspert_adgroup_id": "123:777",
      "adgroup_id": "777",
      "adgroup_name": "tucan lorem",
      "adgroup_status": "ACTIVE",
      "adgroup_labels": [
        "elit ipsum"
      ],
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "campaign_optimize": true,
      "campaign_labels": [
        "ipsum dolor"
      ],
      "campaign_optimization_type": "CLICK",
      "campaign_optimization_support": "SUPPORTED",
      "campaign_eby_marketplace_id": "amet pariatur",
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_optimization_type": "CLICK",
      "performance_group_enabled": true,
      "performance_group_goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "targets": [
        {
          "adgroup_id": "777",
          "adspert_adgroup_id": "123:777",
          "adgroup_name": "tucan lorem",
          "adgroup_status": "ACTIVE",
          "adgroup_labels": [
            "elit ipsum"
          ],
          "adspert_campaign_id": "123:5555",
          "campaign_id": "5555",
          "campaign_name": "sit ipsum",
          "campaign_type": "AMAZON-SPONSORED-BRANDS",
          "campaign_optimize": true,
          "campaign_labels": [
            "ipsum dolor"
          ],
          "campaign_optimization_type": "CLICK",
          "campaign_optimization_support": "SUPPORTED",
          "campaign_eby_marketplace_id": "amet pariatur",
          "performance_group_id": "1245",
          "performance_group_name": "dolor sit",
          "performance_group_optimization_type": "CLICK",
          "performance_group_enabled": true,
          "performance_group_goals": [
            {
              "goal_type": "CLICKS-PER-DAY",
              "goal_value": 1.41,
              "goal_currency": "AED",
              "goal_micros": 6300000,
              "goal_ratio": 8.77
            }
          ],
          "performance_group_goal_types": [
            "CLICKS-PER-DAY"
          ],
          "adspert_portfolio_id": "123:9999",
          "amz_portfolio_id": "9999",
          "amz_portfolio_name": "elit adlora",
          "sync_mode": "ADD-MISSING",
          "read_only": true
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "adspert_account_id": 1
      }
    }
  }
}

PUT

PUT /v3/customers/(customer_id: int)/product-ax/sync-targets

Update/create product ad sync targets.

Auth mode:

api-token

Access level:

user

Request Data (object list, json or csv)

Name	Type	Description
source_adspert_adgroup_id required	CompositeID	Adspert internal ID of the adgroup. Source auto adgroup that we will sync product ads from. Composite ID specification: {adspert_account_id}:{adgroup_id}
target_adspert_adgroup_id required	CompositeID	Adspert internal ID of the adgroup. Target manual adgroup that we will sync product to. Composite ID specification: {adspert_account_id}:{adgroup_id}
sync_mode required	ApiEnumSyncMode	Mode of the product ad sync.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
created	[ Object ]	List of objects which have been created.
⤷ source_adspert_adgroup_id	CompositeID	See request data description.
⤷ target_adspert_adgroup_id	CompositeID	See request data description.
⤷ sync_mode	ApiEnumSyncMode	See request data description.
unchanged	[ Object ]	List of objects which had no effective change.
⤷ source_adspert_adgroup_id	CompositeID	See request data description.
⤷ target_adspert_adgroup_id	CompositeID	See request data description.
⤷ sync_mode	ApiEnumSyncMode	See request data description.
updated	[ Object ]	List of objects which have been updated.
⤷ source_adspert_adgroup_id	CompositeID	See request data description.
⤷ target_adspert_adgroup_id	CompositeID	See request data description.
⤷ sync_mode	ApiEnumSyncMode	See request data description.

Example

http

PUT /v3/customers/7027038674/product-ax/sync-targets HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "source_adspert_adgroup_id": "123:777",
    "target_adspert_adgroup_id": "123:777",
    "sync_mode": "ADD-MISSING"
  }
]

curl

curl -i -X PUT https://api.adspert.net/v3/customers/7027038674/product-ax/sync-targets -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"source_adspert_adgroup_id": "123:777", "target_adspert_adgroup_id": "123:777", "sync_mode": "ADD-MISSING"}]'

httpie

echo '[
  {
    "source_adspert_adgroup_id": "123:777",
    "sync_mode": "ADD-MISSING",
    "target_adspert_adgroup_id": "123:777"
  }
]' | http PUT https://api.adspert.net/v3/customers/7027038674/product-ax/sync-targets Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.put('https://api.adspert.net/v3/customers/7027038674/product-ax/sync-targets', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'source_adspert_adgroup_id': '123:777', 'target_adspert_adgroup_id': '123:777', 'sync_mode': 'ADD-MISSING'}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "created": [
      {
        "source_adspert_adgroup_id": "123:777",
        "target_adspert_adgroup_id": "123:777",
        "sync_mode": "ADD-MISSING"
      }
    ],
    "unchanged": [
      {
        "source_adspert_adgroup_id": "123:777",
        "target_adspert_adgroup_id": "123:777",
        "sync_mode": "ADD-MISSING"
      }
    ],
    "updated": [
      {
        "source_adspert_adgroup_id": "123:777",
        "target_adspert_adgroup_id": "123:777",
        "sync_mode": "ADD-MISSING"
      }
    ]
  },
  "meta": {}
}

DELETE

DELETE /v3/customers/(customer_id: int)/product-ax/sync-targets

Auth mode:

api-token

Access level:

user

Request Data (object list, json or csv)

Name	Type	Description
target_adspert_adgroup_id required	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}

Response Data (single object, json or csv or xlsx)

Name	Type	Description
deleted	[ Object ]	List of objects which have been deleted.
⤷ target_adspert_adgroup_id	CompositeID	See request data description.
unknown	[ Object ]	List of objects which could not be found.
⤷ target_adspert_adgroup_id	CompositeID	See request data description.

Example

http

DELETE /v3/customers/7027038674/product-ax/sync-targets HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

[
  {
    "target_adspert_adgroup_id": "123:777"
  }
]

curl

curl -i -X DELETE https://api.adspert.net/v3/customers/7027038674/product-ax/sync-targets -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '[{"target_adspert_adgroup_id": "123:777"}]'

httpie

echo '[
  {
    "target_adspert_adgroup_id": "123:777"
  }
]' | http DELETE https://api.adspert.net/v3/customers/7027038674/product-ax/sync-targets Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.delete('https://api.adspert.net/v3/customers/7027038674/product-ax/sync-targets', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json=[{'target_adspert_adgroup_id': '123:777'}])

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "deleted": [
      {
        "target_adspert_adgroup_id": "123:777"
      }
    ],
    "unknown": [
      {
        "target_adspert_adgroup_id": "123:777"
      }
    ]
  },
  "meta": {}
}

Performance

AccountPerformanceCollection

GET

GET /v3/accounts/(adspert_account_id: int)/performance

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where date is on or after this date.
filter_date_le required	Date	Only return results where date is on or before this date.
filter_adgroup_id	[ LargeInteger ]	Only return results matching given adgroup_id values.
filter_adgroup_labels	[ String ]	Only return results matching given adgroup_labels values.
filter_adgroup_name	[ String ]	Only return results matching given adgroup_name values.
filter_adgroup_status	[ AdgroupStatus ]	Only return results matching given adgroup_status values.
filter_adspert_adgroup_id	[ CompositeID ]	Only return results matching given adspert_adgroup_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_criterion_id	[ CompositeID ]	Only return results matching given adspert_criterion_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_id	[ LargeInteger ]	Only return results matching given amz_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_id	[ LargeInteger ]	Only return results matching given campaign_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_criterion_labels	[ String ]	Only return results matching given criterion_labels values.
filter_criterion_match_type	[ CriterionMatchType ]	Only return results matching given criterion_match_type values.
filter_criterion_name	[ String ]	Only return results matching given criterion_name values.
filter_criterion_negative	[ Boolean ]	Only return results matching given criterion_negative values.
filter_criterion_status	[ CriterionStatus ]	Only return results matching given criterion_status values.
filter_criterion_type	[ CriterionType ]	Only return results matching given criterion_type values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_adgroup_id	String	Only return results where adgroup_id matches the given string.
search_adgroup_labels	String	Only return results where adgroup_labels matches the given string.
search_adgroup_name	String	Only return results where adgroup_name matches the given string.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_criterion_id	String	Only return results where criterion_id matches the given string.
search_criterion_labels	String	Only return results where criterion_labels matches the given string.
search_criterion_name	String	Only return results where criterion_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
sort_adgroup_id	SortDirective	Sort results by adgroup_id.
sort_adgroup_name	SortDirective	Sort results by adgroup_name.
sort_adgroup_status	SortDirective	Sort results by adgroup_status.
sort_adspert_adgroup_id	SortDirective	Sort results by adspert_adgroup_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_criterion_id	SortDirective	Sort results by adspert_criterion_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_support	SortDirective	Sort results by campaign_optimization_support.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_status	SortDirective	Sort results by campaign_status.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_click_through_rate	SortDirective	Sort results by click_through_rate.
sort_clicks	SortDirective	Sort results by clicks.
sort_conversion_rate	SortDirective	Sort results by conversion_rate.
sort_conversion_rate_adjusted	SortDirective	Sort results by conversion_rate_adjusted.
sort_conversions	SortDirective	Sort results by conversions.
sort_conversions_adjusted	SortDirective	Sort results by conversions_adjusted.
sort_conversions_for_revenue	SortDirective	Sort results by conversions_for_revenue.
sort_conversions_for_revenue_adjusted	SortDirective	Sort results by conversions_for_revenue_adjusted.
sort_cost	SortDirective	Sort results by cost.
sort_cost_for_click	SortDirective	Sort results by cost_for_click.
sort_cost_for_profit	SortDirective	Sort results by cost_for_profit.
sort_cost_for_revenue	SortDirective	Sort results by cost_for_revenue.
sort_cost_optimization_type_click	SortDirective	Sort results by cost_optimization_type_click.
sort_cost_optimization_type_profit	SortDirective	Sort results by cost_optimization_type_profit.
sort_cost_optimization_type_revenue	SortDirective	Sort results by cost_optimization_type_revenue.
sort_cost_per_click	SortDirective	Sort results by cost_per_click.
sort_cost_per_conversion	SortDirective	Sort results by cost_per_conversion.
sort_cost_per_conversion_adjusted	SortDirective	Sort results by cost_per_conversion_adjusted.
sort_cost_revenue_ratio	SortDirective	Sort results by cost_revenue_ratio.
sort_cost_revenue_ratio_adjusted	SortDirective	Sort results by cost_revenue_ratio_adjusted.
sort_criterion_id	SortDirective	Sort results by criterion_id.
sort_criterion_match_type	SortDirective	Sort results by criterion_match_type.
sort_criterion_name	SortDirective	Sort results by criterion_name.
sort_criterion_status	SortDirective	Sort results by criterion_status.
sort_criterion_type	SortDirective	Sort results by criterion_type.
sort_date	SortDirective	Sort results by date.
sort_impressions	SortDirective	Sort results by impressions.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
sort_profit	SortDirective	Sort results by profit.
sort_profit_adjusted	SortDirective	Sort results by profit_adjusted.
sort_profit_gross	SortDirective	Sort results by profit_gross.
sort_profit_gross_adjusted	SortDirective	Sort results by profit_gross_adjusted.
sort_profit_net	SortDirective	Sort results by profit_net.
sort_profit_net_adjusted	SortDirective	Sort results by profit_net_adjusted.
sort_return_on_ad_spend	SortDirective	Sort results by return_on_ad_spend.
sort_return_on_ad_spend_adjusted	SortDirective	Sort results by return_on_ad_spend_adjusted.
sort_return_on_investment	SortDirective	Sort results by return_on_investment.
sort_return_on_investment_adjusted	SortDirective	Sort results by return_on_investment_adjusted.
sort_revenue	SortDirective	Sort results by revenue.
sort_revenue_adjusted	SortDirective	Sort results by revenue_adjusted.
sort_revenue_per_conversion	SortDirective	Sort results by revenue_per_conversion.
sort_revenue_per_conversion_adjusted	SortDirective	Sort results by revenue_per_conversion_adjusted.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1
group_by required	AccountPerformanceGroupBy	Grouping/segementation level for the results.
currency required	Currency

Response Data (object list, json or csv or xlsx)

Name	Type	Description
date	Date
performance_group_id searchable	Integer	Unique ID of the performance group
performance_group_name searchable	String	Unique name of the performance group.
performance_group_enabled	Boolean
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
performance_group_user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger
amz_portfolio_name searchable	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger
campaign_name searchable	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_status	CampaignStatus
campaign_optimize	Boolean
campaign_optimization_type	OptimizationType
campaign_optimization_support	CampaignOptimizationSupport
campaign_labels searchable	[ String ]
campaign_user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.
adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
adgroup_id searchable	LargeInteger
adgroup_name searchable	String
adgroup_status	AdgroupStatus
adgroup_labels searchable	[ String ]
adspert_criterion_id	CompositeID	Adspert internal ID of the criterion. Composite ID specification: {adspert_account_id}:{adgroup_id}:{criterion_id}
criterion_id searchable	LargeInteger
criterion_name searchable	String
criterion_status	CriterionStatus
criterion_type	CriterionType
criterion_match_type	CriterionMatchType	Match type of Keyword criterion. NULL if criterion_type is not Keyword.
criterion_labels searchable	[ String ]
criterion_negative	Boolean	Indicates if criterion is a negative criterion.
criterion_max_cpc	Integer	Max CPC for criterion.
impressions	Integer	Number of impressions
clicks	Integer	Number of clicks
conversions	Float	Number of conversions. Always 0 for click optimized campaigns.
conversions_adjusted	Float	Number of conversions adjusted for conversion delay. Always 0 for click optimized campaigns.
conversions_for_revenue	Float	Number of conversions for campaigns that support revenues. Always 0 for campaigns that don’t support revenue.
conversions_for_revenue_adjusted	Float	Number of conversions for campaigns that support revenues adjusted for conversion delay. Always 0 for campaigns that don’t support revenue.
profit	Micros	Profit. Always 0 for click and revenue optimized campaigns. DEPRECATED: Use profit_gross instead.
profit_adjusted	Micros	Profit adjusted for conversion delay. Always 0 for click and revenue optimized campaigns. DEPRECATED: Use profit_gross_adjusted instead.
profit_gross	Micros	Gross profit. Always 0 for click and revenue optimized campaigns.
profit_gross_adjusted	Micros	Gross profit adjusted for conversion delay. Always 0 for click and revenue optimized campaigns.
profit_net	Micros	Net profit. profit_gross - cost_for_profit Always 0 for click and revenue optimized campaigns.
profit_net_adjusted	Micros	Net profit adjusted for conversion delay. profit_gross_adjusted - cost_for_profit Always 0 for click and revenue optimized campaigns.
revenue	Micros	Revenue/sales. Always 0 for click and profit optimized campaigns.
revenue_adjusted	Micros	Revenue/sales adjusted for conversion delay. Always 0 for click and profit optimized campaigns.
cost	Micros	Total ad spend / cost
cost_optimization_type_click	Micros	Ad spend / cost from click optimized campaigns. Always 0 for revenue and profit optimized campaigns. DEPRECATED: Use cost_for_click instead.
cost_optimization_type_profit	Micros	Ad spend / cost from profit optimized campaigns. Always 0 for click and revenue optimized campaigns. DEPRECATED: Use cost_for_profit instead.
cost_optimization_type_revenue	Micros	Ad spend / cost from revenue optimized campaigns. Always 0 for click and profit optimized campaigns. DEPRECATED: Use cost_for_revenue instead.
cost_for_profit	Micros	Ad spend from campaigns that support profit. Always 0 for campaigns that don’t support profit.
cost_for_revenue	Micros	Ad spend from campaigns that support revenue. Always 0 for campaigns that don’t support revenue.
cost_for_click	Micros	Ad spend / cost from click optimized campaigns. Always 0 for revenue and profit optimized campaigns.
cost_per_click	Micros	Effective CPC. cost / clicks NULL if number of clicks is 0.
cost_per_conversion	Micros	Cost per conversion. Only cost for profit and revenue optimized campaigns is included. (cost - cost_for_click) / conversions NULL if number of conversions is 0.
cost_per_conversion_adjusted	Micros	Cost per conversion, adjusted for conversion delay. Only cost for profit and revenue optimized campaigns is included. (cost - cost_for_click) / conversions_adjusted NULL if number of conversions_adjusted is 0.
conversion_rate	Float	Conversion rate. conversions / clicks NULL if number of clicks is 0.
conversion_rate_adjusted	Float	Conversion rate, adjusted for conversion delay. conversions_adjusted / clicks NULL if number of clicks is 0.
click_through_rate	Float	Clickthrough rate (CTR). clicks / impressions NULL if number of impressions is 0.
return_on_investment	Float	Return on investment (ROI). Only cost for profit optimized campaigns is included. profit_gross / cost_for_profit NULL if cost_for_profit is 0.
return_on_investment_adjusted	Float	Return on investment (ROI), adjusted for conversion delay. Only cost for profit optimized campaigns is included. profit_gross_adjusted / cost_for_profit NULL if cost_for_profit is 0.
return_on_ad_spend	Float	Return on ad spend (ROAS). Only cost for revenue optimized campaigns is included. revenue / cost_for_revenue NULL if cost_for_revenue is 0.
return_on_ad_spend_adjusted	Float	Return on ad spend (ROAS), adjusted for conversion delay. Only cost for revenue optimized campaigns is included. revenue_adjusted / cost_for_revenue NULL if cost_for_revenue is 0.
cost_revenue_ratio	Float	Cost Revenue Ratio (CRR). Also called Advertising Cost of Sale (ACoS). Only cost for revenue optimized campaigns is included. cost_for_revenue / revenue NULL if revenue is 0.
cost_revenue_ratio_adjusted	Float	Cost Revenue Ratio (CRR), adjusted for conversion delay. Also called Advertising Cost of Sale (ACoS). Only cost for revenue optimized campaigns is included. cost_for_revenue / revenue_adjusted NULL if cost_for_revenue is 0.
revenue_per_conversion	Micros	Revenue per conversions. Only revenue and conversions for revenue supporting campaigns are included. revenue / conversions_for_revenue NULL if campaign doesn’t support revenue.
revenue_per_conversion_adjusted	Micros	Revenue per conversions adjusted for conversion delay. Only revenue and conversions for revenue supporting campaigns are included. revenue_adjusted / conversions_for_revenue_adjusted NULL if campaign doesn’t support revenue.

Example

http

GET /v3/accounts/3420379091/performance?sort_campaign_status=-6&filter_campaign_id=11114176131520763170733335&search_criterion_name=elit+amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/accounts/3420379091/performance?sort_campaign_status=-6&filter_campaign_id=11114176131520763170733335&search_criterion_name=elit+amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/accounts/3420379091/performance?sort_campaign_status=-6&filter_campaign_id=11114176131520763170733335&search_criterion_name=elit+amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/accounts/3420379091/performance?sort_campaign_status=-6&filter_campaign_id=11114176131520763170733335&search_criterion_name=elit+amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "date": "2018-10-21",
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_enabled": true,
      "performance_group_optimization_type": "CLICK",
      "performance_group_goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "performance_group_user_max_bid": {
        "micros": 8340000,
        "currency": "AED"
      },
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "campaign_eby_marketplace_id": "amet pariatur",
      "campaign_status": "ACTIVE",
      "campaign_optimize": true,
      "campaign_optimization_type": "CLICK",
      "campaign_optimization_support": "SUPPORTED",
      "campaign_labels": [
        "ipsum dolor"
      ],
      "campaign_user_max_bid": {
        "micros": 8340000,
        "currency": "AED"
      },
      "adspert_adgroup_id": "123:777",
      "adgroup_id": "777",
      "adgroup_name": "tucan lorem",
      "adgroup_status": "ACTIVE",
      "adgroup_labels": [
        "elit ipsum"
      ],
      "adspert_criterion_id": "123:777:66789",
      "criterion_id": "66789",
      "criterion_name": "dolor adlora",
      "criterion_status": "ACTIVE",
      "criterion_type": "AUDIENCE",
      "criterion_match_type": "BROAD",
      "criterion_labels": [
        "adlora dolor"
      ],
      "criterion_negative": true,
      "criterion_max_cpc": 9336765101,
      "impressions": 2157218327,
      "clicks": 5857268080,
      "conversions": 3.92,
      "conversions_adjusted": 18.15,
      "conversions_for_revenue": 4.57,
      "conversions_for_revenue_adjusted": 4.9,
      "profit": 9510000,
      "profit_adjusted": 2710000,
      "profit_gross": 6420000,
      "profit_gross_adjusted": 9200000,
      "profit_net": 30000,
      "profit_net_adjusted": 3540000,
      "revenue": 360000,
      "revenue_adjusted": 9120000,
      "cost": 4540000,
      "cost_optimization_type_click": 7130000,
      "cost_optimization_type_profit": 8820000,
      "cost_optimization_type_revenue": 820000,
      "cost_for_profit": 800000,
      "cost_for_revenue": 6910000,
      "cost_for_click": 6810000,
      "cost_per_click": 7300000,
      "cost_per_conversion": 7570000,
      "cost_per_conversion_adjusted": 340000,
      "conversion_rate": 0.86,
      "conversion_rate_adjusted": 4.8,
      "click_through_rate": 7.58,
      "return_on_investment": 3.28,
      "return_on_investment_adjusted": 1.3,
      "return_on_ad_spend": 2.29,
      "return_on_ad_spend_adjusted": 8.05,
      "cost_revenue_ratio": 16.41,
      "cost_revenue_ratio_adjusted": 10.14,
      "revenue_per_conversion": 7070000,
      "revenue_per_conversion_adjusted": 4550000
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "date": 1
      }
    }
  }
}

CustomerPerformanceCollection

GET

GET /v3/customers/(customer_id: int)/performance

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where date is on or after this date.
filter_date_le required	Date	Only return results where date is on or before this date.
filter_impressions_le	Integer	Only return results where impressions is equal or lower than this value.
filter_impressions_ge	Integer	Only return results where impressions is equal or greater than this value.
filter_clicks_le	Integer	Only return results where clicks is equal or lower than this value.
filter_clicks_ge	Integer	Only return results where clicks is equal or greater than this value.
filter_conversions_le	Float	Only return results where conversions is equal or lower than this value.
filter_conversions_ge	Float	Only return results where conversions is equal or greater than this value.
filter_conversions_adjusted_le	Float	Only return results where conversions_adjusted is equal or lower than this value.
filter_conversions_adjusted_ge	Float	Only return results where conversions_adjusted is equal or greater than this value.
filter_profit_le	Micros	Only return results where profit is equal or lower than this value. DEPRECATED: Use profit_gross instead. Min value: 1000
filter_profit_ge	Micros	Only return results where profit is equal or greater than this value. DEPRECATED: Use profit_gross instead. Min value: 1000
filter_profit_adjusted_le	Micros	Only return results where profit_adjusted is equal or lower than this value. DEPRECATED: Use profit_gross_adjusted instead. Min value: 1000
filter_profit_adjusted_ge	Micros	Only return results where profit_adjusted is equal or greater than this value. DEPRECATED: Use profit_gross_adjusted instead. Min value: 1000
filter_profit_gross_le	Micros	Only return results where profit_gross is equal or lower than this value. Min value: 1000
filter_profit_gross_ge	Micros	Only return results where profit_gross is equal or greater than this value. Min value: 1000
filter_profit_gross_adjusted_le	Micros	Only return results where profit_gross_adjusted is equal or lower than this value. Min value: 1000
filter_profit_gross_adjusted_ge	Micros	Only return results where profit_gross_adjusted is equal or greater than this value. Min value: 1000
filter_profit_net_le	Micros	Only return results where profit_net is equal or lower than this value. Min value: 1000
filter_profit_net_ge	Micros	Only return results where profit_net is equal or greater than this value. Min value: 1000
filter_profit_net_adjusted_le	Micros	Only return results where profit_net_adjusted is equal or lower than this value. Min value: 1000
filter_profit_net_adjusted_ge	Micros	Only return results where profit_net_adjusted is equal or greater than this value. Min value: 1000
filter_revenue_le	Micros	Only return results where revenue is equal or lower than this value. Min value: 1000
filter_revenue_ge	Micros	Only return results where revenue is equal or greater than this value. Min value: 1000
filter_revenue_adjusted_le	Micros	Only return results where revenue_adjusted is equal or lower than this value. Min value: 1000
filter_revenue_adjusted_ge	Micros	Only return results where revenue_adjusted is equal or greater than this value. Min value: 1000
filter_cost_le	Micros	Only return results where cost is equal or lower than this value. Min value: 1000
filter_cost_ge	Micros	Only return results where cost is equal or greater than this value. Min value: 1000
filter_cost_optimization_type_click_le	Micros	Only return results where cost_optimization_type_click is equal or lower than this value. DEPRECATED: Use cost_for_click instead. Min value: 1000
filter_cost_optimization_type_click_ge	Micros	Only return results where cost_optimization_type_click is equal or greater than this value. DEPRECATED: Use cost_for_click instead. Min value: 1000
filter_cost_optimization_type_profit_le	Micros	Only return results where cost_optimization_type_profit is equal or lower than this value. DEPRECATED: Use cost_for_profit instead. Min value: 1000
filter_cost_optimization_type_profit_ge	Micros	Only return results where cost_optimization_type_profit is equal or greater than this value. DEPRECATED: Use cost_for_profit instead. Min value: 1000
filter_cost_optimization_type_revenue_le	Micros	Only return results where cost_optimization_type_revenue is equal or lower than this value. DEPRECATED: Use cost_for_revenue instead. Min value: 1000
filter_cost_optimization_type_revenue_ge	Micros	Only return results where cost_optimization_type_revenue is equal or greater than this value. DEPRECATED: Use cost_for_revenue instead. Min value: 1000
filter_cost_per_click_le	Micros	Only return results where cost_per_click is equal or lower than this value. Min value: 1000
filter_cost_per_click_ge	Micros	Only return results where cost_per_click is equal or greater than this value. Min value: 1000
filter_cost_per_conversion_le	Micros	Only return results where cost_per_conversion is equal or lower than this value. Min value: 1000
filter_cost_per_conversion_ge	Micros	Only return results where cost_per_conversion is equal or greater than this value. Min value: 1000
filter_cost_per_conversion_adjusted_le	Micros	Only return results where cost_per_conversion_adjusted is equal or lower than this value. Min value: 1000
filter_cost_per_conversion_adjusted_ge	Micros	Only return results where cost_per_conversion_adjusted is equal or greater than this value. Min value: 1000
filter_conversion_rate_le	Float	Only return results where conversion_rate is equal or lower than this value.
filter_conversion_rate_ge	Float	Only return results where conversion_rate is equal or greater than this value.
filter_conversion_rate_adjusted_le	Float	Only return results where conversion_rate_adjusted is equal or lower than this value.
filter_conversion_rate_adjusted_ge	Float	Only return results where conversion_rate_adjusted is equal or greater than this value.
filter_click_through_rate_le	Float	Only return results where click_through_rate is equal or lower than this value.
filter_click_through_rate_ge	Float	Only return results where click_through_rate is equal or greater than this value.
filter_return_on_investment_le	Float	Only return results where return_on_investment is equal or lower than this value.
filter_return_on_investment_ge	Float	Only return results where return_on_investment is equal or greater than this value.
filter_return_on_investment_adjusted_le	Float	Only return results where return_on_investment_adjusted is equal or lower than this value.
filter_return_on_investment_adjusted_ge	Float	Only return results where return_on_investment_adjusted is equal or greater than this value.
filter_return_on_ad_spend_le	Float	Only return results where return_on_ad_spend is equal or lower than this value.
filter_return_on_ad_spend_ge	Float	Only return results where return_on_ad_spend is equal or greater than this value.
filter_return_on_ad_spend_adjusted_le	Float	Only return results where return_on_ad_spend_adjusted is equal or lower than this value.
filter_return_on_ad_spend_adjusted_ge	Float	Only return results where return_on_ad_spend_adjusted is equal or greater than this value.
filter_cost_revenue_ratio_le	Float	Only return results where cost_revenue_ratio is equal or lower than this value.
filter_cost_revenue_ratio_ge	Float	Only return results where cost_revenue_ratio is equal or greater than this value.
filter_cost_revenue_ratio_adjusted_le	Float	Only return results where cost_revenue_ratio_adjusted is equal or lower than this value.
filter_cost_revenue_ratio_adjusted_ge	Float	Only return results where cost_revenue_ratio_adjusted is equal or greater than this value.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_is_demo	SortDirective	Sort results by account_is_demo.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_optimize	SortDirective	Sort results by account_optimize.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_support	SortDirective	Sort results by campaign_optimization_support.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_status	SortDirective	Sort results by campaign_status.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_click_through_rate	SortDirective	Sort results by click_through_rate.
sort_clicks	SortDirective	Sort results by clicks.
sort_conversion_rate	SortDirective	Sort results by conversion_rate.
sort_conversion_rate_adjusted	SortDirective	Sort results by conversion_rate_adjusted.
sort_conversions	SortDirective	Sort results by conversions.
sort_conversions_adjusted	SortDirective	Sort results by conversions_adjusted.
sort_conversions_for_revenue	SortDirective	Sort results by conversions_for_revenue.
sort_conversions_for_revenue_adjusted	SortDirective	Sort results by conversions_for_revenue_adjusted.
sort_cost	SortDirective	Sort results by cost.
sort_cost_for_click	SortDirective	Sort results by cost_for_click.
sort_cost_for_organic	SortDirective	Sort results by cost_for_organic.
sort_cost_for_organic_rolling_avg	SortDirective	Sort results by cost_for_organic_rolling_avg.
sort_cost_for_profit	SortDirective	Sort results by cost_for_profit.
sort_cost_for_revenue	SortDirective	Sort results by cost_for_revenue.
sort_cost_optimization_type_click	SortDirective	Sort results by cost_optimization_type_click.
sort_cost_optimization_type_profit	SortDirective	Sort results by cost_optimization_type_profit.
sort_cost_optimization_type_revenue	SortDirective	Sort results by cost_optimization_type_revenue.
sort_cost_per_click	SortDirective	Sort results by cost_per_click.
sort_cost_per_conversion	SortDirective	Sort results by cost_per_conversion.
sort_cost_per_conversion_adjusted	SortDirective	Sort results by cost_per_conversion_adjusted.
sort_cost_revenue_ratio	SortDirective	Sort results by cost_revenue_ratio.
sort_cost_revenue_ratio_adjusted	SortDirective	Sort results by cost_revenue_ratio_adjusted.
sort_cost_revenue_total_ratio	SortDirective	Sort results by cost_revenue_total_ratio.
sort_cost_revenue_total_ratio_rolling_avg	SortDirective	Sort results by cost_revenue_total_ratio_rolling_avg.
sort_date	SortDirective	Sort results by date.
sort_impressions	SortDirective	Sort results by impressions.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
sort_profit	SortDirective	Sort results by profit.
sort_profit_adjusted	SortDirective	Sort results by profit_adjusted.
sort_profit_gross	SortDirective	Sort results by profit_gross.
sort_profit_gross_adjusted	SortDirective	Sort results by profit_gross_adjusted.
sort_profit_net	SortDirective	Sort results by profit_net.
sort_profit_net_adjusted	SortDirective	Sort results by profit_net_adjusted.
sort_return_on_ad_spend	SortDirective	Sort results by return_on_ad_spend.
sort_return_on_ad_spend_adjusted	SortDirective	Sort results by return_on_ad_spend_adjusted.
sort_return_on_investment	SortDirective	Sort results by return_on_investment.
sort_return_on_investment_adjusted	SortDirective	Sort results by return_on_investment_adjusted.
sort_revenue	SortDirective	Sort results by revenue.
sort_revenue_adjusted	SortDirective	Sort results by revenue_adjusted.
sort_revenue_organic	SortDirective	Sort results by revenue_organic.
sort_revenue_organic_adjusted	SortDirective	Sort results by revenue_organic_adjusted.
sort_revenue_per_conversion	SortDirective	Sort results by revenue_per_conversion.
sort_revenue_per_conversion_adjusted	SortDirective	Sort results by revenue_per_conversion_adjusted.
sort_revenue_total	SortDirective	Sort results by revenue_total.
sort_revenue_total_rolling_avg	SortDirective	Sort results by revenue_total_rolling_avg.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1
group_by required	CustomerPerformanceGroupBy	Grouping/segementation level for the results.
currency required	Currency

Response Data (object list, json or csv or xlsx)

Name	Type	Description
date	Date
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_id searchable	String	Ad platform specific ID of an advertising account.
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
account_optimize	Boolean	If optimization by Adspert is enabled for this account.
account_tags_user searchable	[ String ]
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
performance_group_id searchable	Integer	Unique ID of the performance group
performance_group_name searchable	String	Unique name of the performance group.
performance_group_enabled	Boolean
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
performance_group_platforms	[ AdPlatform ]	List of platforms that PG runs on. NULL when grouped by date, account, amz_portfolio
performance_group_user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger
amz_portfolio_name searchable	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger
campaign_name searchable	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_status	CampaignStatus
campaign_optimize	Boolean
campaign_optimization_type	OptimizationType
campaign_optimization_support	CampaignOptimizationSupport
campaign_labels searchable	[ String ]
campaign_user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.
impressions	Integer	Number of impressions
clicks	Integer	Number of clicks
conversions	Float	Number of conversions. Always 0 for click optimized campaigns.
conversions_adjusted	Float	Number of conversions adjusted for conversion delay. Always 0 for click optimized campaigns.
conversions_for_revenue	Float	Number of conversions for campaigns that support revenues. Always 0 for campaigns that don’t support revenue.
conversions_for_revenue_adjusted	Float	Number of conversions for campaigns that support revenues adjusted for conversion delay. Always 0 for campaigns that don’t support revenue.
profit	Micros	Profit. Always 0 for click and revenue optimized campaigns. DEPRECATED: Use profit_gross instead.
profit_adjusted	Micros	Profit adjusted for conversion delay. Always 0 for click and revenue optimized campaigns. DEPRECATED: Use profit_gross_adjusted instead.
profit_gross	Micros	Gross profit. Always 0 for click and revenue optimized campaigns.
profit_gross_adjusted	Micros	Gross profit adjusted for conversion delay. Always 0 for click and revenue optimized campaigns.
profit_net	Micros	Net profit. profit_gross - cost_for_profit Always 0 for click and revenue optimized campaigns.
profit_net_adjusted	Micros	Net profit adjusted for conversion delay. profit_gross_adjusted - cost_for_profit Always 0 for click and revenue optimized campaigns.
revenue	Micros	Revenue/sales. Always 0 for click and profit optimized campaigns.
revenue_adjusted	Micros	Revenue/sales adjusted for conversion delay. Always 0 for click and profit optimized campaigns.
revenue_total	Micros	Total revenue (organic + paid sales). This is only available on account-level and includes only revenue from ad accounts for which organic performance data is available (Amazon Ads).
revenue_total_rolling_avg	Micros	Same as revenue_total but as a 7-day rolling average.
revenue_organic	Micros	Organic revenue This is only available on account-level and includes only revenue from ad accounts for which organic performance data is available (Amazon Ads).
revenue_organic_adjusted	Micros	Organic revenue adjusted for conversion delay This is only available on account-level and includes only revenue from ad accounts for which organic performance data is available (Amazon Ads).
cost	Micros	Total ad spend / cost
cost_optimization_type_click	Micros	Ad spend / cost from click optimized campaigns. Always 0 for revenue and profit optimized campaigns. DEPRECATED: Use cost_for_click instead.
cost_optimization_type_profit	Micros	Ad spend / cost from profit optimized campaigns. Always 0 for click and revenue optimized campaigns. DEPRECATED: Use cost_for_profit instead.
cost_optimization_type_revenue	Micros	Ad spend / cost from revenue optimized campaigns. Always 0 for click and profit optimized campaigns. DEPRECATED: Use cost_for_revenue instead.
cost_for_profit	Micros	Ad spend from campaigns that support profit. Always 0 for campaigns that don’t support profit.
cost_for_revenue	Micros	Ad spend from campaigns that support revenue. Always 0 for campaigns that don’t support revenue.
cost_for_click	Micros	Ad spend / cost from click optimized campaigns. Always 0 for revenue and profit optimized campaigns.
cost_for_organic	Micros	Ad spend from campaigns in ad accounts for which organic performance data is available (relevant for TACoS metric). Always 0 for campaigns in ad accounts w/o organic performance data.
cost_for_organic_rolling_avg	Micros	Same as cost_for_organic but as a 7-day rolling average.
cost_per_click	Micros	Effective CPC. cost / clicks NULL if number of clicks is 0.
cost_per_conversion	Micros	Cost per conversion. Only cost for profit and revenue optimized campaigns is included. (cost - cost_for_click) / conversions NULL if number of conversions is 0.
cost_per_conversion_adjusted	Micros	Cost per conversion, adjusted for conversion delay. Only cost for profit and revenue optimized campaigns is included. (cost - cost_for_click) / conversions_adjusted NULL if number of conversions_adjusted is 0.
conversion_rate	Float	Conversion rate. conversions / clicks NULL if number of clicks is 0.
conversion_rate_adjusted	Float	Conversion rate, adjusted for conversion delay. conversions_adjusted / clicks NULL if number of clicks is 0.
click_through_rate	Float	Clickthrough rate (CTR). clicks / impressions NULL if number of impressions is 0.
return_on_investment	Float	Return on investment (ROI). Only cost for profit optimized campaigns is included. profit_gross / cost_for_profit NULL if cost_for_profit is 0.
return_on_investment_adjusted	Float	Return on investment (ROI), adjusted for conversion delay. Only cost for profit optimized campaigns is included. profit_gross_adjusted / cost_for_profit NULL if cost_for_profit is 0.
return_on_ad_spend	Float	Return on ad spend (ROAS). Only cost for revenue optimized campaigns is included. revenue / cost_for_revenue NULL if cost_for_revenue is 0.
return_on_ad_spend_adjusted	Float	Return on ad spend (ROAS), adjusted for conversion delay. Only cost for revenue optimized campaigns is included. revenue_adjusted / cost_for_revenue NULL if cost_for_revenue is 0.
cost_revenue_ratio	Float	Cost Revenue Ratio (CRR). Also called Advertising Cost of Sale (ACoS). Only cost for revenue optimized campaigns is included. cost_for_revenue / revenue NULL if revenue is 0.
cost_revenue_ratio_adjusted	Float	Cost Revenue Ratio (CRR), adjusted for conversion delay. Also called Advertising Cost of Sale (ACoS). Only cost for revenue optimized campaigns is included. cost_for_revenue / revenue_adjusted NULL if cost_for_revenue is 0.
cost_revenue_total_ratio	Float	Total Cost Revenue Ratio (CRR), including organic revenue, a.k.a. Total Advertising Cost of Sale (TACoS). This is only available on account-level and includes only revenue and cost from ad accounts for which organic performance data is available (Amazon Ads). NULL if revenue_total is 0.
cost_revenue_total_ratio_rolling_avg	Float	Same as cost_revenue_total_ratio but as a 7-day rolling average. NULL if total_revenue_rolling_avg is 0.
revenue_per_conversion	Micros	Revenue per conversions. Only revenue and conversions for revenue supporting campaigns are included. revenue / conversions_for_revenue NULL if campaign doesn’t support revenue.
revenue_per_conversion_adjusted	Micros	Revenue per conversions adjusted for conversion delay. Only revenue and conversions for revenue supporting campaigns are included. revenue_adjusted / conversions_for_revenue_adjusted NULL if campaign doesn’t support revenue.

Example

http

GET /v3/customers/7027038674/performance?filter_cost_optimization_type_profit_ge=9930000&filter_account_id=amet+lorem&filter_date_le=2018-10-21 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/performance?filter_cost_optimization_type_profit_ge=9930000&filter_account_id=amet+lorem&filter_date_le=2018-10-21' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/performance?filter_cost_optimization_type_profit_ge=9930000&filter_account_id=amet+lorem&filter_date_le=2018-10-21' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/performance?filter_cost_optimization_type_profit_ge=9930000&filter_account_id=amet+lorem&filter_date_le=2018-10-21', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "date": "2018-10-21",
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "account_optimize": true,
      "account_tags_user": [
        "vehicula amet"
      ],
      "account_is_demo": true,
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_enabled": true,
      "performance_group_optimization_type": "CLICK",
      "performance_group_goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "performance_group_platforms": [
        "AMAZON"
      ],
      "performance_group_user_max_bid": {
        "micros": 8340000,
        "currency": "AED"
      },
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "campaign_eby_marketplace_id": "amet pariatur",
      "campaign_status": "ACTIVE",
      "campaign_optimize": true,
      "campaign_optimization_type": "CLICK",
      "campaign_optimization_support": "SUPPORTED",
      "campaign_labels": [
        "ipsum dolor"
      ],
      "campaign_user_max_bid": {
        "micros": 8340000,
        "currency": "AED"
      },
      "impressions": 2157218327,
      "clicks": 5857268080,
      "conversions": 3.92,
      "conversions_adjusted": 18.15,
      "conversions_for_revenue": 4.57,
      "conversions_for_revenue_adjusted": 4.9,
      "profit": 9510000,
      "profit_adjusted": 2710000,
      "profit_gross": 6420000,
      "profit_gross_adjusted": 9200000,
      "profit_net": 30000,
      "profit_net_adjusted": 3540000,
      "revenue": 360000,
      "revenue_adjusted": 9120000,
      "revenue_total": 9370000,
      "revenue_total_rolling_avg": 2650000,
      "revenue_organic": 2410000,
      "revenue_organic_adjusted": 3080000,
      "cost": 4540000,
      "cost_optimization_type_click": 7130000,
      "cost_optimization_type_profit": 8820000,
      "cost_optimization_type_revenue": 820000,
      "cost_for_profit": 800000,
      "cost_for_revenue": 6910000,
      "cost_for_click": 6810000,
      "cost_for_organic": 3360000,
      "cost_for_organic_rolling_avg": 4530000,
      "cost_per_click": 7300000,
      "cost_per_conversion": 7570000,
      "cost_per_conversion_adjusted": 340000,
      "conversion_rate": 0.86,
      "conversion_rate_adjusted": 4.8,
      "click_through_rate": 7.58,
      "return_on_investment": 3.28,
      "return_on_investment_adjusted": 1.3,
      "return_on_ad_spend": 2.29,
      "return_on_ad_spend_adjusted": 8.05,
      "cost_revenue_ratio": 16.41,
      "cost_revenue_ratio_adjusted": 10.14,
      "cost_revenue_total_ratio": 9.0,
      "cost_revenue_total_ratio_rolling_avg": 18.81,
      "revenue_per_conversion": 7070000,
      "revenue_per_conversion_adjusted": 4550000
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "date": 1
      }
    }
  }
}

POST

POST /v3/customers/(customer_id: int)/performance

Auth mode:

api-token

Access level:

user

Request Data (single object, json)

Name	Type	Description
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
group_by required	CustomerPerformanceGroupBy	Grouping/segementation level for the results.
filter_date_ge required	Date	Only return results where date is on or after this date.
filter_date_le required	Date	Only return results where date is on or before this date.
currency required	Currency
filter_impressions_le	Integer	Only return results where impressions is equal or lower than this value.
filter_impressions_ge	Integer	Only return results where impressions is equal or greater than this value.
filter_clicks_le	Integer	Only return results where clicks is equal or lower than this value.
filter_clicks_ge	Integer	Only return results where clicks is equal or greater than this value.
filter_conversions_le	Float	Only return results where conversions is equal or lower than this value.
filter_conversions_ge	Float	Only return results where conversions is equal or greater than this value.
filter_conversions_adjusted_le	Float	Only return results where conversions_adjusted is equal or lower than this value.
filter_conversions_adjusted_ge	Float	Only return results where conversions_adjusted is equal or greater than this value.
filter_profit_le	Micros	Only return results where profit is equal or lower than this value. DEPRECATED: Use profit_gross instead. Min value: 1000
filter_profit_ge	Micros	Only return results where profit is equal or greater than this value. DEPRECATED: Use profit_gross instead. Min value: 1000
filter_profit_adjusted_le	Micros	Only return results where profit_adjusted is equal or lower than this value. DEPRECATED: Use profit_gross_adjusted instead. Min value: 1000
filter_profit_adjusted_ge	Micros	Only return results where profit_adjusted is equal or greater than this value. DEPRECATED: Use profit_gross_adjusted instead. Min value: 1000
filter_profit_gross_le	Micros	Only return results where profit_gross is equal or lower than this value. Min value: 1000
filter_profit_gross_ge	Micros	Only return results where profit_gross is equal or greater than this value. Min value: 1000
filter_profit_gross_adjusted_le	Micros	Only return results where profit_gross_adjusted is equal or lower than this value. Min value: 1000
filter_profit_gross_adjusted_ge	Micros	Only return results where profit_gross_adjusted is equal or greater than this value. Min value: 1000
filter_profit_net_le	Micros	Only return results where profit_net is equal or lower than this value. Min value: 1000
filter_profit_net_ge	Micros	Only return results where profit_net is equal or greater than this value. Min value: 1000
filter_profit_net_adjusted_le	Micros	Only return results where profit_net_adjusted is equal or lower than this value. Min value: 1000
filter_profit_net_adjusted_ge	Micros	Only return results where profit_net_adjusted is equal or greater than this value. Min value: 1000
filter_revenue_le	Micros	Only return results where revenue is equal or lower than this value. Min value: 1000
filter_revenue_ge	Micros	Only return results where revenue is equal or greater than this value. Min value: 1000
filter_revenue_adjusted_le	Micros	Only return results where revenue_adjusted is equal or lower than this value. Min value: 1000
filter_revenue_adjusted_ge	Micros	Only return results where revenue_adjusted is equal or greater than this value. Min value: 1000
filter_cost_le	Micros	Only return results where cost is equal or lower than this value. Min value: 1000
filter_cost_ge	Micros	Only return results where cost is equal or greater than this value. Min value: 1000
filter_cost_optimization_type_click_le	Micros	Only return results where cost_optimization_type_click is equal or lower than this value. DEPRECATED: Use cost_for_click instead. Min value: 1000
filter_cost_optimization_type_click_ge	Micros	Only return results where cost_optimization_type_click is equal or greater than this value. DEPRECATED: Use cost_for_click instead. Min value: 1000
filter_cost_optimization_type_profit_le	Micros	Only return results where cost_optimization_type_profit is equal or lower than this value. DEPRECATED: Use cost_for_profit instead. Min value: 1000
filter_cost_optimization_type_profit_ge	Micros	Only return results where cost_optimization_type_profit is equal or greater than this value. DEPRECATED: Use cost_for_profit instead. Min value: 1000
filter_cost_optimization_type_revenue_le	Micros	Only return results where cost_optimization_type_revenue is equal or lower than this value. DEPRECATED: Use cost_for_revenue instead. Min value: 1000
filter_cost_optimization_type_revenue_ge	Micros	Only return results where cost_optimization_type_revenue is equal or greater than this value. DEPRECATED: Use cost_for_revenue instead. Min value: 1000
filter_cost_per_click_le	Micros	Only return results where cost_per_click is equal or lower than this value. Min value: 1000
filter_cost_per_click_ge	Micros	Only return results where cost_per_click is equal or greater than this value. Min value: 1000
filter_cost_per_conversion_le	Micros	Only return results where cost_per_conversion is equal or lower than this value. Min value: 1000
filter_cost_per_conversion_ge	Micros	Only return results where cost_per_conversion is equal or greater than this value. Min value: 1000
filter_cost_per_conversion_adjusted_le	Micros	Only return results where cost_per_conversion_adjusted is equal or lower than this value. Min value: 1000
filter_cost_per_conversion_adjusted_ge	Micros	Only return results where cost_per_conversion_adjusted is equal or greater than this value. Min value: 1000
filter_conversion_rate_le	Float	Only return results where conversion_rate is equal or lower than this value.
filter_conversion_rate_ge	Float	Only return results where conversion_rate is equal or greater than this value.
filter_conversion_rate_adjusted_le	Float	Only return results where conversion_rate_adjusted is equal or lower than this value.
filter_conversion_rate_adjusted_ge	Float	Only return results where conversion_rate_adjusted is equal or greater than this value.
filter_click_through_rate_le	Float	Only return results where click_through_rate is equal or lower than this value.
filter_click_through_rate_ge	Float	Only return results where click_through_rate is equal or greater than this value.
filter_return_on_investment_le	Float	Only return results where return_on_investment is equal or lower than this value.
filter_return_on_investment_ge	Float	Only return results where return_on_investment is equal or greater than this value.
filter_return_on_investment_adjusted_le	Float	Only return results where return_on_investment_adjusted is equal or lower than this value.
filter_return_on_investment_adjusted_ge	Float	Only return results where return_on_investment_adjusted is equal or greater than this value.
filter_return_on_ad_spend_le	Float	Only return results where return_on_ad_spend is equal or lower than this value.
filter_return_on_ad_spend_ge	Float	Only return results where return_on_ad_spend is equal or greater than this value.
filter_return_on_ad_spend_adjusted_le	Float	Only return results where return_on_ad_spend_adjusted is equal or lower than this value.
filter_return_on_ad_spend_adjusted_ge	Float	Only return results where return_on_ad_spend_adjusted is equal or greater than this value.
filter_cost_revenue_ratio_le	Float	Only return results where cost_revenue_ratio is equal or lower than this value.
filter_cost_revenue_ratio_ge	Float	Only return results where cost_revenue_ratio is equal or greater than this value.
filter_cost_revenue_ratio_adjusted_le	Float	Only return results where cost_revenue_ratio_adjusted is equal or lower than this value.
filter_cost_revenue_ratio_adjusted_ge	Float	Only return results where cost_revenue_ratio_adjusted is equal or greater than this value.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_is_demo	SortDirective	Sort results by account_is_demo.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_optimize	SortDirective	Sort results by account_optimize.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_support	SortDirective	Sort results by campaign_optimization_support.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_status	SortDirective	Sort results by campaign_status.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_click_through_rate	SortDirective	Sort results by click_through_rate.
sort_clicks	SortDirective	Sort results by clicks.
sort_conversion_rate	SortDirective	Sort results by conversion_rate.
sort_conversion_rate_adjusted	SortDirective	Sort results by conversion_rate_adjusted.
sort_conversions	SortDirective	Sort results by conversions.
sort_conversions_adjusted	SortDirective	Sort results by conversions_adjusted.
sort_conversions_for_revenue	SortDirective	Sort results by conversions_for_revenue.
sort_conversions_for_revenue_adjusted	SortDirective	Sort results by conversions_for_revenue_adjusted.
sort_cost	SortDirective	Sort results by cost.
sort_cost_for_click	SortDirective	Sort results by cost_for_click.
sort_cost_for_organic	SortDirective	Sort results by cost_for_organic.
sort_cost_for_organic_rolling_avg	SortDirective	Sort results by cost_for_organic_rolling_avg.
sort_cost_for_profit	SortDirective	Sort results by cost_for_profit.
sort_cost_for_revenue	SortDirective	Sort results by cost_for_revenue.
sort_cost_optimization_type_click	SortDirective	Sort results by cost_optimization_type_click.
sort_cost_optimization_type_profit	SortDirective	Sort results by cost_optimization_type_profit.
sort_cost_optimization_type_revenue	SortDirective	Sort results by cost_optimization_type_revenue.
sort_cost_per_click	SortDirective	Sort results by cost_per_click.
sort_cost_per_conversion	SortDirective	Sort results by cost_per_conversion.
sort_cost_per_conversion_adjusted	SortDirective	Sort results by cost_per_conversion_adjusted.
sort_cost_revenue_ratio	SortDirective	Sort results by cost_revenue_ratio.
sort_cost_revenue_ratio_adjusted	SortDirective	Sort results by cost_revenue_ratio_adjusted.
sort_cost_revenue_total_ratio	SortDirective	Sort results by cost_revenue_total_ratio.
sort_cost_revenue_total_ratio_rolling_avg	SortDirective	Sort results by cost_revenue_total_ratio_rolling_avg.
sort_date	SortDirective	Sort results by date.
sort_impressions	SortDirective	Sort results by impressions.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
sort_profit	SortDirective	Sort results by profit.
sort_profit_adjusted	SortDirective	Sort results by profit_adjusted.
sort_profit_gross	SortDirective	Sort results by profit_gross.
sort_profit_gross_adjusted	SortDirective	Sort results by profit_gross_adjusted.
sort_profit_net	SortDirective	Sort results by profit_net.
sort_profit_net_adjusted	SortDirective	Sort results by profit_net_adjusted.
sort_return_on_ad_spend	SortDirective	Sort results by return_on_ad_spend.
sort_return_on_ad_spend_adjusted	SortDirective	Sort results by return_on_ad_spend_adjusted.
sort_return_on_investment	SortDirective	Sort results by return_on_investment.
sort_return_on_investment_adjusted	SortDirective	Sort results by return_on_investment_adjusted.
sort_revenue	SortDirective	Sort results by revenue.
sort_revenue_adjusted	SortDirective	Sort results by revenue_adjusted.
sort_revenue_organic	SortDirective	Sort results by revenue_organic.
sort_revenue_organic_adjusted	SortDirective	Sort results by revenue_organic_adjusted.
sort_revenue_per_conversion	SortDirective	Sort results by revenue_per_conversion.
sort_revenue_per_conversion_adjusted	SortDirective	Sort results by revenue_per_conversion_adjusted.
sort_revenue_total	SortDirective	Sort results by revenue_total.
sort_revenue_total_rolling_avg	SortDirective	Sort results by revenue_total_rolling_avg.

Response Data (object list, json or csv or xlsx)

Name	Type	Description
date	Date
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_id searchable	String	Ad platform specific ID of an advertising account.
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
account_optimize	Boolean	If optimization by Adspert is enabled for this account.
account_tags_user searchable	[ String ]
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
performance_group_id searchable	Integer	Unique ID of the performance group
performance_group_name searchable	String	Unique name of the performance group.
performance_group_enabled	Boolean
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
performance_group_platforms	[ AdPlatform ]	List of platforms that PG runs on. NULL when grouped by date, account, amz_portfolio
performance_group_user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger
amz_portfolio_name searchable	String
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger
campaign_name searchable	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_status	CampaignStatus
campaign_optimize	Boolean
campaign_optimization_type	OptimizationType
campaign_optimization_support	CampaignOptimizationSupport
campaign_labels searchable	[ String ]
campaign_user_max_bid	Object	Max bid for the performance group or campaign
⤷ micros	Micros	Monetary value in micros.
⤷ currency	Currency	Currency of the monetary value.
impressions	Integer	Number of impressions
clicks	Integer	Number of clicks
conversions	Float	Number of conversions. Always 0 for click optimized campaigns.
conversions_adjusted	Float	Number of conversions adjusted for conversion delay. Always 0 for click optimized campaigns.
conversions_for_revenue	Float	Number of conversions for campaigns that support revenues. Always 0 for campaigns that don’t support revenue.
conversions_for_revenue_adjusted	Float	Number of conversions for campaigns that support revenues adjusted for conversion delay. Always 0 for campaigns that don’t support revenue.
profit	Micros	Profit. Always 0 for click and revenue optimized campaigns. DEPRECATED: Use profit_gross instead.
profit_adjusted	Micros	Profit adjusted for conversion delay. Always 0 for click and revenue optimized campaigns. DEPRECATED: Use profit_gross_adjusted instead.
profit_gross	Micros	Gross profit. Always 0 for click and revenue optimized campaigns.
profit_gross_adjusted	Micros	Gross profit adjusted for conversion delay. Always 0 for click and revenue optimized campaigns.
profit_net	Micros	Net profit. profit_gross - cost_for_profit Always 0 for click and revenue optimized campaigns.
profit_net_adjusted	Micros	Net profit adjusted for conversion delay. profit_gross_adjusted - cost_for_profit Always 0 for click and revenue optimized campaigns.
revenue	Micros	Revenue/sales. Always 0 for click and profit optimized campaigns.
revenue_adjusted	Micros	Revenue/sales adjusted for conversion delay. Always 0 for click and profit optimized campaigns.
revenue_total	Micros	Total revenue (organic + paid sales). This is only available on account-level and includes only revenue from ad accounts for which organic performance data is available (Amazon Ads).
revenue_total_rolling_avg	Micros	Same as revenue_total but as a 7-day rolling average.
revenue_organic	Micros	Organic revenue This is only available on account-level and includes only revenue from ad accounts for which organic performance data is available (Amazon Ads).
revenue_organic_adjusted	Micros	Organic revenue adjusted for conversion delay This is only available on account-level and includes only revenue from ad accounts for which organic performance data is available (Amazon Ads).
cost	Micros	Total ad spend / cost
cost_optimization_type_click	Micros	Ad spend / cost from click optimized campaigns. Always 0 for revenue and profit optimized campaigns. DEPRECATED: Use cost_for_click instead.
cost_optimization_type_profit	Micros	Ad spend / cost from profit optimized campaigns. Always 0 for click and revenue optimized campaigns. DEPRECATED: Use cost_for_profit instead.
cost_optimization_type_revenue	Micros	Ad spend / cost from revenue optimized campaigns. Always 0 for click and profit optimized campaigns. DEPRECATED: Use cost_for_revenue instead.
cost_for_profit	Micros	Ad spend from campaigns that support profit. Always 0 for campaigns that don’t support profit.
cost_for_revenue	Micros	Ad spend from campaigns that support revenue. Always 0 for campaigns that don’t support revenue.
cost_for_click	Micros	Ad spend / cost from click optimized campaigns. Always 0 for revenue and profit optimized campaigns.
cost_for_organic	Micros	Ad spend from campaigns in ad accounts for which organic performance data is available (relevant for TACoS metric). Always 0 for campaigns in ad accounts w/o organic performance data.
cost_for_organic_rolling_avg	Micros	Same as cost_for_organic but as a 7-day rolling average.
cost_per_click	Micros	Effective CPC. cost / clicks NULL if number of clicks is 0.
cost_per_conversion	Micros	Cost per conversion. Only cost for profit and revenue optimized campaigns is included. (cost - cost_for_click) / conversions NULL if number of conversions is 0.
cost_per_conversion_adjusted	Micros	Cost per conversion, adjusted for conversion delay. Only cost for profit and revenue optimized campaigns is included. (cost - cost_for_click) / conversions_adjusted NULL if number of conversions_adjusted is 0.
conversion_rate	Float	Conversion rate. conversions / clicks NULL if number of clicks is 0.
conversion_rate_adjusted	Float	Conversion rate, adjusted for conversion delay. conversions_adjusted / clicks NULL if number of clicks is 0.
click_through_rate	Float	Clickthrough rate (CTR). clicks / impressions NULL if number of impressions is 0.
return_on_investment	Float	Return on investment (ROI). Only cost for profit optimized campaigns is included. profit_gross / cost_for_profit NULL if cost_for_profit is 0.
return_on_investment_adjusted	Float	Return on investment (ROI), adjusted for conversion delay. Only cost for profit optimized campaigns is included. profit_gross_adjusted / cost_for_profit NULL if cost_for_profit is 0.
return_on_ad_spend	Float	Return on ad spend (ROAS). Only cost for revenue optimized campaigns is included. revenue / cost_for_revenue NULL if cost_for_revenue is 0.
return_on_ad_spend_adjusted	Float	Return on ad spend (ROAS), adjusted for conversion delay. Only cost for revenue optimized campaigns is included. revenue_adjusted / cost_for_revenue NULL if cost_for_revenue is 0.
cost_revenue_ratio	Float	Cost Revenue Ratio (CRR). Also called Advertising Cost of Sale (ACoS). Only cost for revenue optimized campaigns is included. cost_for_revenue / revenue NULL if revenue is 0.
cost_revenue_ratio_adjusted	Float	Cost Revenue Ratio (CRR), adjusted for conversion delay. Also called Advertising Cost of Sale (ACoS). Only cost for revenue optimized campaigns is included. cost_for_revenue / revenue_adjusted NULL if cost_for_revenue is 0.
cost_revenue_total_ratio	Float	Total Cost Revenue Ratio (CRR), including organic revenue, a.k.a. Total Advertising Cost of Sale (TACoS). This is only available on account-level and includes only revenue and cost from ad accounts for which organic performance data is available (Amazon Ads). NULL if revenue_total is 0.
cost_revenue_total_ratio_rolling_avg	Float	Same as cost_revenue_total_ratio but as a 7-day rolling average. NULL if total_revenue_rolling_avg is 0.
revenue_per_conversion	Micros	Revenue per conversions. Only revenue and conversions for revenue supporting campaigns are included. revenue / conversions_for_revenue NULL if campaign doesn’t support revenue.
revenue_per_conversion_adjusted	Micros	Revenue per conversions adjusted for conversion delay. Only revenue and conversions for revenue supporting campaigns are included. revenue_adjusted / conversions_for_revenue_adjusted NULL if campaign doesn’t support revenue.

Example

http

POST /v3/customers/7027038674/performance HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

{
  "search_fields": [
    "pariatur.adlora"
  ],
  "search_term": "vehicula ipsum",
  "offset": 0,
  "limit": 10,
  "include": [
    "ipsum.amet"
  ],
  "exclude": [
    "elit.amet"
  ],
  "group_by": "ACCOUNT",
  "filter_date_ge": "2018-10-21",
  "filter_date_le": "2018-10-21",
  "currency": "AED",
  "filter_impressions_le": 1895730553,
  "filter_impressions_ge": 2586369292,
  "filter_clicks_le": 4787837344,
  "filter_clicks_ge": 6848626767,
  "filter_conversions_le": 10.95,
  "filter_conversions_ge": 8.67,
  "filter_conversions_adjusted_le": 0.41,
  "filter_conversions_adjusted_ge": 14.26,
  "filter_profit_le": 7930000,
  "filter_profit_ge": 1400000,
  "filter_profit_adjusted_le": 5320000,
  "filter_profit_adjusted_ge": 4990000,
  "filter_profit_gross_le": 9520000,
  "filter_profit_gross_ge": 7910000,
  "filter_profit_gross_adjusted_le": 8130000,
  "filter_profit_gross_adjusted_ge": 7970000,
  "filter_profit_net_le": 7290000,
  "filter_profit_net_ge": 8640000,
  "filter_profit_net_adjusted_le": 8470000,
  "filter_profit_net_adjusted_ge": 7160000,
  "filter_revenue_le": 440000,
  "filter_revenue_ge": 8770000,
  "filter_revenue_adjusted_le": 7490000,
  "filter_revenue_adjusted_ge": 7810000,
  "filter_cost_le": 3590000,
  "filter_cost_ge": 4630000,
  "filter_cost_optimization_type_click_le": 3880000,
  "filter_cost_optimization_type_click_ge": 8700000,
  "filter_cost_optimization_type_profit_le": 7860000,
  "filter_cost_optimization_type_profit_ge": 9930000,
  "filter_cost_optimization_type_revenue_le": 6530000,
  "filter_cost_optimization_type_revenue_ge": 8310000,
  "filter_cost_per_click_le": 6500000,
  "filter_cost_per_click_ge": 6110000,
  "filter_cost_per_conversion_le": 9820000,
  "filter_cost_per_conversion_ge": 9650000,
  "filter_cost_per_conversion_adjusted_le": 2350000,
  "filter_cost_per_conversion_adjusted_ge": 5290000,
  "filter_conversion_rate_le": 7.8,
  "filter_conversion_rate_ge": 6.44,
  "filter_conversion_rate_adjusted_le": 5.88,
  "filter_conversion_rate_adjusted_ge": 2.14,
  "filter_click_through_rate_le": 9.53,
  "filter_click_through_rate_ge": 3.91,
  "filter_return_on_investment_le": 5.79,
  "filter_return_on_investment_ge": 1.24,
  "filter_return_on_investment_adjusted_le": 7.11,
  "filter_return_on_investment_adjusted_ge": 2.03,
  "filter_return_on_ad_spend_le": 11.53,
  "filter_return_on_ad_spend_ge": 18.33,
  "filter_return_on_ad_spend_adjusted_le": 6.06,
  "filter_return_on_ad_spend_adjusted_ge": 14.05,
  "filter_cost_revenue_ratio_le": 7.67,
  "filter_cost_revenue_ratio_ge": 4.23,
  "filter_cost_revenue_ratio_adjusted_le": 11.89,
  "filter_cost_revenue_ratio_adjusted_ge": 0.62,
  "filter_account_id": [
    "amet lorem"
  ],
  "filter_account_is_demo": [
    true
  ],
  "filter_account_name": [
    "vehicula ipsum"
  ],
  "filter_account_optimize": [
    true
  ],
  "filter_account_platform": [
    "AMAZON"
  ],
  "filter_account_tags_user": [
    "vehicula amet"
  ],
  "filter_adspert_account_id": [
    3420379091
  ],
  "filter_adspert_campaign_id": [
    "123:80"
  ],
  "filter_adspert_portfolio_id": [
    "123:23"
  ],
  "filter_amz_portfolio_name": [
    "elit adlora"
  ],
  "filter_campaign_eby_marketplace_id": [
    "amet pariatur"
  ],
  "filter_campaign_labels": [
    "ipsum dolor"
  ],
  "filter_campaign_name": [
    "sit ipsum"
  ],
  "filter_campaign_optimization_support": [
    "SUPPORTED"
  ],
  "filter_campaign_optimization_type": [
    "CLICK"
  ],
  "filter_campaign_optimize": [
    true
  ],
  "filter_campaign_status": [
    "ACTIVE"
  ],
  "filter_campaign_type": [
    "AMAZON-SPONSORED-BRANDS"
  ],
  "filter_performance_group_enabled": [
    true
  ],
  "filter_performance_group_goal_types": [
    "CLICKS-PER-DAY"
  ],
  "filter_performance_group_id": [
    6668648308
  ],
  "filter_performance_group_name": [
    "dolor sit"
  ],
  "filter_performance_group_optimization_type": [
    "CLICK"
  ],
  "search_account_id": "elit dolor",
  "search_account_name": "sit tucan",
  "search_account_tags_user": "dolor elit",
  "search_adspert_account_id": "dolor vehicula",
  "search_amz_portfolio_id": "tucan adlora",
  "search_amz_portfolio_name": "lorem tucan",
  "search_campaign_id": "dolor amet",
  "search_campaign_labels": "dolor ipsum",
  "search_campaign_name": "lorem tucan",
  "search_performance_group_id": "ipsum lorem",
  "search_performance_group_name": "tucan lorem",
  "sort_account_id": 7,
  "sort_account_is_demo": -6,
  "sort_account_name": 5,
  "sort_account_optimize": 0,
  "sort_account_platform": 3,
  "sort_adspert_account_id": -2,
  "sort_adspert_campaign_id": 9,
  "sort_adspert_portfolio_id": -8,
  "sort_amz_portfolio_id": -2,
  "sort_amz_portfolio_name": -6,
  "sort_campaign_eby_marketplace_id": 3,
  "sort_campaign_id": 9,
  "sort_campaign_name": 5,
  "sort_campaign_optimization_support": 0,
  "sort_campaign_optimization_type": -4,
  "sort_campaign_optimize": 7,
  "sort_campaign_status": -6,
  "sort_campaign_type": -6,
  "sort_click_through_rate": -8,
  "sort_clicks": 1,
  "sort_conversion_rate": 5,
  "sort_conversion_rate_adjusted": 3,
  "sort_conversions": 9,
  "sort_conversions_adjusted": -6,
  "sort_conversions_for_revenue": -4,
  "sort_conversions_for_revenue_adjusted": -2,
  "sort_cost": -8,
  "sort_cost_for_click": -8,
  "sort_cost_for_organic": 3,
  "sort_cost_for_organic_rolling_avg": -2,
  "sort_cost_for_profit": -6,
  "sort_cost_for_revenue": -4,
  "sort_cost_optimization_type_click": -4,
  "sort_cost_optimization_type_profit": 5,
  "sort_cost_optimization_type_revenue": 0,
  "sort_cost_per_click": -4,
  "sort_cost_per_conversion": 3,
  "sort_cost_per_conversion_adjusted": 0,
  "sort_cost_revenue_ratio": -2,
  "sort_cost_revenue_ratio_adjusted": -2,
  "sort_cost_revenue_total_ratio": 3,
  "sort_cost_revenue_total_ratio_rolling_avg": 5,
  "sort_date": -6,
  "sort_impressions": 1,
  "sort_performance_group_enabled": 7,
  "sort_performance_group_goal_types": 7,
  "sort_performance_group_id": 7,
  "sort_performance_group_name": -6,
  "sort_performance_group_optimization_type": 1,
  "sort_profit": -2,
  "sort_profit_adjusted": 5,
  "sort_profit_gross": -8,
  "sort_profit_gross_adjusted": 9,
  "sort_profit_net": 9,
  "sort_profit_net_adjusted": 1,
  "sort_return_on_ad_spend": -4,
  "sort_return_on_ad_spend_adjusted": -4,
  "sort_return_on_investment": 0,
  "sort_return_on_investment_adjusted": 3,
  "sort_revenue": 1,
  "sort_revenue_adjusted": -8,
  "sort_revenue_organic": 3,
  "sort_revenue_organic_adjusted": 1,
  "sort_revenue_per_conversion": 3,
  "sort_revenue_per_conversion_adjusted": -4,
  "sort_revenue_total": -6,
  "sort_revenue_total_rolling_avg": 1
}

curl

curl -i -X POST https://api.adspert.net/v3/customers/7027038674/performance -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '{"currency": "AED", "exclude": ["elit.amet"], "filter_account_id": ["amet lorem"], "filter_account_is_demo": [true], "filter_account_name": ["vehicula ipsum"], "filter_account_optimize": [true], "filter_account_platform": ["AMAZON"], "filter_account_tags_user": ["vehicula amet"], "filter_adspert_account_id": [3420379091], "filter_adspert_campaign_id": ["123:80"], "filter_adspert_portfolio_id": ["123:23"], "filter_amz_portfolio_name": ["elit adlora"], "filter_campaign_eby_marketplace_id": ["amet pariatur"], "filter_campaign_labels": ["ipsum dolor"], "filter_campaign_name": ["sit ipsum"], "filter_campaign_optimization_support": ["SUPPORTED"], "filter_campaign_optimization_type": ["CLICK"], "filter_campaign_optimize": [true], "filter_campaign_status": ["ACTIVE"], "filter_campaign_type": ["AMAZON-SPONSORED-BRANDS"], "filter_click_through_rate_ge": 3.91, "filter_click_through_rate_le": 9.53, "filter_clicks_ge": 6848626767, "filter_clicks_le": 4787837344, "filter_conversion_rate_adjusted_ge": 2.14, "filter_conversion_rate_adjusted_le": 5.88, "filter_conversion_rate_ge": 6.44, "filter_conversion_rate_le": 7.8, "filter_conversions_adjusted_ge": 14.26, "filter_conversions_adjusted_le": 0.41, "filter_conversions_ge": 8.67, "filter_conversions_le": 10.95, "filter_cost_ge": 4630000, "filter_cost_le": 3590000, "filter_cost_optimization_type_click_ge": 8700000, "filter_cost_optimization_type_click_le": 3880000, "filter_cost_optimization_type_profit_ge": 9930000, "filter_cost_optimization_type_profit_le": 7860000, "filter_cost_optimization_type_revenue_ge": 8310000, "filter_cost_optimization_type_revenue_le": 6530000, "filter_cost_per_click_ge": 6110000, "filter_cost_per_click_le": 6500000, "filter_cost_per_conversion_adjusted_ge": 5290000, "filter_cost_per_conversion_adjusted_le": 2350000, "filter_cost_per_conversion_ge": 9650000, "filter_cost_per_conversion_le": 9820000, "filter_cost_revenue_ratio_adjusted_ge": 0.62, "filter_cost_revenue_ratio_adjusted_le": 11.89, "filter_cost_revenue_ratio_ge": 4.23, "filter_cost_revenue_ratio_le": 7.67, "filter_date_ge": "2018-10-21", "filter_date_le": "2018-10-21", "filter_impressions_ge": 2586369292, "filter_impressions_le": 1895730553, "filter_performance_group_enabled": [true], "filter_performance_group_goal_types": ["CLICKS-PER-DAY"], "filter_performance_group_id": [6668648308], "filter_performance_group_name": ["dolor sit"], "filter_performance_group_optimization_type": ["CLICK"], "filter_profit_adjusted_ge": 4990000, "filter_profit_adjusted_le": 5320000, "filter_profit_ge": 1400000, "filter_profit_gross_adjusted_ge": 7970000, "filter_profit_gross_adjusted_le": 8130000, "filter_profit_gross_ge": 7910000, "filter_profit_gross_le": 9520000, "filter_profit_le": 7930000, "filter_profit_net_adjusted_ge": 7160000, "filter_profit_net_adjusted_le": 8470000, "filter_profit_net_ge": 8640000, "filter_profit_net_le": 7290000, "filter_return_on_ad_spend_adjusted_ge": 14.05, "filter_return_on_ad_spend_adjusted_le": 6.06, "filter_return_on_ad_spend_ge": 18.33, "filter_return_on_ad_spend_le": 11.53, "filter_return_on_investment_adjusted_ge": 2.03, "filter_return_on_investment_adjusted_le": 7.11, "filter_return_on_investment_ge": 1.24, "filter_return_on_investment_le": 5.79, "filter_revenue_adjusted_ge": 7810000, "filter_revenue_adjusted_le": 7490000, "filter_revenue_ge": 8770000, "filter_revenue_le": 440000, "group_by": "ACCOUNT", "include": ["ipsum.amet"], "limit": 10, "offset": 0, "search_account_id": "elit dolor", "search_account_name": "sit tucan", "search_account_tags_user": "dolor elit", "search_adspert_account_id": "dolor vehicula", "search_amz_portfolio_id": "tucan adlora", "search_amz_portfolio_name": "lorem tucan", "search_campaign_id": "dolor amet", "search_campaign_labels": "dolor ipsum", "search_campaign_name": "lorem tucan", "search_fields": ["pariatur.adlora"], "search_performance_group_id": "ipsum lorem", "search_performance_group_name": "tucan lorem", "search_term": "vehicula ipsum", "sort_account_id": 7, "sort_account_is_demo": -6, "sort_account_name": 5, "sort_account_optimize": 0, "sort_account_platform": 3, "sort_adspert_account_id": -2, "sort_adspert_campaign_id": 9, "sort_adspert_portfolio_id": -8, "sort_amz_portfolio_id": -2, "sort_amz_portfolio_name": -6, "sort_campaign_eby_marketplace_id": 3, "sort_campaign_id": 9, "sort_campaign_name": 5, "sort_campaign_optimization_support": 0, "sort_campaign_optimization_type": -4, "sort_campaign_optimize": 7, "sort_campaign_status": -6, "sort_campaign_type": -6, "sort_click_through_rate": -8, "sort_clicks": 1, "sort_conversion_rate": 5, "sort_conversion_rate_adjusted": 3, "sort_conversions": 9, "sort_conversions_adjusted": -6, "sort_conversions_for_revenue": -4, "sort_conversions_for_revenue_adjusted": -2, "sort_cost": -8, "sort_cost_for_click": -8, "sort_cost_for_organic": 3, "sort_cost_for_organic_rolling_avg": -2, "sort_cost_for_profit": -6, "sort_cost_for_revenue": -4, "sort_cost_optimization_type_click": -4, "sort_cost_optimization_type_profit": 5, "sort_cost_optimization_type_revenue": 0, "sort_cost_per_click": -4, "sort_cost_per_conversion": 3, "sort_cost_per_conversion_adjusted": 0, "sort_cost_revenue_ratio": -2, "sort_cost_revenue_ratio_adjusted": -2, "sort_cost_revenue_total_ratio": 3, "sort_cost_revenue_total_ratio_rolling_avg": 5, "sort_date": -6, "sort_impressions": 1, "sort_performance_group_enabled": 7, "sort_performance_group_goal_types": 7, "sort_performance_group_id": 7, "sort_performance_group_name": -6, "sort_performance_group_optimization_type": 1, "sort_profit": -2, "sort_profit_adjusted": 5, "sort_profit_gross": -8, "sort_profit_gross_adjusted": 9, "sort_profit_net": 9, "sort_profit_net_adjusted": 1, "sort_return_on_ad_spend": -4, "sort_return_on_ad_spend_adjusted": -4, "sort_return_on_investment": 0, "sort_return_on_investment_adjusted": 3, "sort_revenue": 1, "sort_revenue_adjusted": -8, "sort_revenue_organic": 3, "sort_revenue_organic_adjusted": 1, "sort_revenue_per_conversion": 3, "sort_revenue_per_conversion_adjusted": -4, "sort_revenue_total": -6, "sort_revenue_total_rolling_avg": 1}'

httpie

echo '{
  "currency": "AED",
  "exclude": [
    "elit.amet"
  ],
  "filter_account_id": [
    "amet lorem"
  ],
  "filter_account_is_demo": [
    true
  ],
  "filter_account_name": [
    "vehicula ipsum"
  ],
  "filter_account_optimize": [
    true
  ],
  "filter_account_platform": [
    "AMAZON"
  ],
  "filter_account_tags_user": [
    "vehicula amet"
  ],
  "filter_adspert_account_id": [
    3420379091
  ],
  "filter_adspert_campaign_id": [
    "123:80"
  ],
  "filter_adspert_portfolio_id": [
    "123:23"
  ],
  "filter_amz_portfolio_name": [
    "elit adlora"
  ],
  "filter_campaign_eby_marketplace_id": [
    "amet pariatur"
  ],
  "filter_campaign_labels": [
    "ipsum dolor"
  ],
  "filter_campaign_name": [
    "sit ipsum"
  ],
  "filter_campaign_optimization_support": [
    "SUPPORTED"
  ],
  "filter_campaign_optimization_type": [
    "CLICK"
  ],
  "filter_campaign_optimize": [
    true
  ],
  "filter_campaign_status": [
    "ACTIVE"
  ],
  "filter_campaign_type": [
    "AMAZON-SPONSORED-BRANDS"
  ],
  "filter_click_through_rate_ge": 3.91,
  "filter_click_through_rate_le": 9.53,
  "filter_clicks_ge": 6848626767,
  "filter_clicks_le": 4787837344,
  "filter_conversion_rate_adjusted_ge": 2.14,
  "filter_conversion_rate_adjusted_le": 5.88,
  "filter_conversion_rate_ge": 6.44,
  "filter_conversion_rate_le": 7.8,
  "filter_conversions_adjusted_ge": 14.26,
  "filter_conversions_adjusted_le": 0.41,
  "filter_conversions_ge": 8.67,
  "filter_conversions_le": 10.95,
  "filter_cost_ge": 4630000,
  "filter_cost_le": 3590000,
  "filter_cost_optimization_type_click_ge": 8700000,
  "filter_cost_optimization_type_click_le": 3880000,
  "filter_cost_optimization_type_profit_ge": 9930000,
  "filter_cost_optimization_type_profit_le": 7860000,
  "filter_cost_optimization_type_revenue_ge": 8310000,
  "filter_cost_optimization_type_revenue_le": 6530000,
  "filter_cost_per_click_ge": 6110000,
  "filter_cost_per_click_le": 6500000,
  "filter_cost_per_conversion_adjusted_ge": 5290000,
  "filter_cost_per_conversion_adjusted_le": 2350000,
  "filter_cost_per_conversion_ge": 9650000,
  "filter_cost_per_conversion_le": 9820000,
  "filter_cost_revenue_ratio_adjusted_ge": 0.62,
  "filter_cost_revenue_ratio_adjusted_le": 11.89,
  "filter_cost_revenue_ratio_ge": 4.23,
  "filter_cost_revenue_ratio_le": 7.67,
  "filter_date_ge": "2018-10-21",
  "filter_date_le": "2018-10-21",
  "filter_impressions_ge": 2586369292,
  "filter_impressions_le": 1895730553,
  "filter_performance_group_enabled": [
    true
  ],
  "filter_performance_group_goal_types": [
    "CLICKS-PER-DAY"
  ],
  "filter_performance_group_id": [
    6668648308
  ],
  "filter_performance_group_name": [
    "dolor sit"
  ],
  "filter_performance_group_optimization_type": [
    "CLICK"
  ],
  "filter_profit_adjusted_ge": 4990000,
  "filter_profit_adjusted_le": 5320000,
  "filter_profit_ge": 1400000,
  "filter_profit_gross_adjusted_ge": 7970000,
  "filter_profit_gross_adjusted_le": 8130000,
  "filter_profit_gross_ge": 7910000,
  "filter_profit_gross_le": 9520000,
  "filter_profit_le": 7930000,
  "filter_profit_net_adjusted_ge": 7160000,
  "filter_profit_net_adjusted_le": 8470000,
  "filter_profit_net_ge": 8640000,
  "filter_profit_net_le": 7290000,
  "filter_return_on_ad_spend_adjusted_ge": 14.05,
  "filter_return_on_ad_spend_adjusted_le": 6.06,
  "filter_return_on_ad_spend_ge": 18.33,
  "filter_return_on_ad_spend_le": 11.53,
  "filter_return_on_investment_adjusted_ge": 2.03,
  "filter_return_on_investment_adjusted_le": 7.11,
  "filter_return_on_investment_ge": 1.24,
  "filter_return_on_investment_le": 5.79,
  "filter_revenue_adjusted_ge": 7810000,
  "filter_revenue_adjusted_le": 7490000,
  "filter_revenue_ge": 8770000,
  "filter_revenue_le": 440000,
  "group_by": "ACCOUNT",
  "include": [
    "ipsum.amet"
  ],
  "limit": 10,
  "offset": 0,
  "search_account_id": "elit dolor",
  "search_account_name": "sit tucan",
  "search_account_tags_user": "dolor elit",
  "search_adspert_account_id": "dolor vehicula",
  "search_amz_portfolio_id": "tucan adlora",
  "search_amz_portfolio_name": "lorem tucan",
  "search_campaign_id": "dolor amet",
  "search_campaign_labels": "dolor ipsum",
  "search_campaign_name": "lorem tucan",
  "search_fields": [
    "pariatur.adlora"
  ],
  "search_performance_group_id": "ipsum lorem",
  "search_performance_group_name": "tucan lorem",
  "search_term": "vehicula ipsum",
  "sort_account_id": 7,
  "sort_account_is_demo": -6,
  "sort_account_name": 5,
  "sort_account_optimize": 0,
  "sort_account_platform": 3,
  "sort_adspert_account_id": -2,
  "sort_adspert_campaign_id": 9,
  "sort_adspert_portfolio_id": -8,
  "sort_amz_portfolio_id": -2,
  "sort_amz_portfolio_name": -6,
  "sort_campaign_eby_marketplace_id": 3,
  "sort_campaign_id": 9,
  "sort_campaign_name": 5,
  "sort_campaign_optimization_support": 0,
  "sort_campaign_optimization_type": -4,
  "sort_campaign_optimize": 7,
  "sort_campaign_status": -6,
  "sort_campaign_type": -6,
  "sort_click_through_rate": -8,
  "sort_clicks": 1,
  "sort_conversion_rate": 5,
  "sort_conversion_rate_adjusted": 3,
  "sort_conversions": 9,
  "sort_conversions_adjusted": -6,
  "sort_conversions_for_revenue": -4,
  "sort_conversions_for_revenue_adjusted": -2,
  "sort_cost": -8,
  "sort_cost_for_click": -8,
  "sort_cost_for_organic": 3,
  "sort_cost_for_organic_rolling_avg": -2,
  "sort_cost_for_profit": -6,
  "sort_cost_for_revenue": -4,
  "sort_cost_optimization_type_click": -4,
  "sort_cost_optimization_type_profit": 5,
  "sort_cost_optimization_type_revenue": 0,
  "sort_cost_per_click": -4,
  "sort_cost_per_conversion": 3,
  "sort_cost_per_conversion_adjusted": 0,
  "sort_cost_revenue_ratio": -2,
  "sort_cost_revenue_ratio_adjusted": -2,
  "sort_cost_revenue_total_ratio": 3,
  "sort_cost_revenue_total_ratio_rolling_avg": 5,
  "sort_date": -6,
  "sort_impressions": 1,
  "sort_performance_group_enabled": 7,
  "sort_performance_group_goal_types": 7,
  "sort_performance_group_id": 7,
  "sort_performance_group_name": -6,
  "sort_performance_group_optimization_type": 1,
  "sort_profit": -2,
  "sort_profit_adjusted": 5,
  "sort_profit_gross": -8,
  "sort_profit_gross_adjusted": 9,
  "sort_profit_net": 9,
  "sort_profit_net_adjusted": 1,
  "sort_return_on_ad_spend": -4,
  "sort_return_on_ad_spend_adjusted": -4,
  "sort_return_on_investment": 0,
  "sort_return_on_investment_adjusted": 3,
  "sort_revenue": 1,
  "sort_revenue_adjusted": -8,
  "sort_revenue_organic": 3,
  "sort_revenue_organic_adjusted": 1,
  "sort_revenue_per_conversion": 3,
  "sort_revenue_per_conversion_adjusted": -4,
  "sort_revenue_total": -6,
  "sort_revenue_total_rolling_avg": 1
}' | http POST https://api.adspert.net/v3/customers/7027038674/performance Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.post('https://api.adspert.net/v3/customers/7027038674/performance', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json={'currency': 'AED', 'exclude': ['elit.amet'], 'filter_account_id': ['amet lorem'], 'filter_account_is_demo': [True], 'filter_account_name': ['vehicula ipsum'], 'filter_account_optimize': [True], 'filter_account_platform': ['AMAZON'], 'filter_account_tags_user': ['vehicula amet'], 'filter_adspert_account_id': [3420379091], 'filter_adspert_campaign_id': ['123:80'], 'filter_adspert_portfolio_id': ['123:23'], 'filter_amz_portfolio_name': ['elit adlora'], 'filter_campaign_eby_marketplace_id': ['amet pariatur'], 'filter_campaign_labels': ['ipsum dolor'], 'filter_campaign_name': ['sit ipsum'], 'filter_campaign_optimization_support': ['SUPPORTED'], 'filter_campaign_optimization_type': ['CLICK'], 'filter_campaign_optimize': [True], 'filter_campaign_status': ['ACTIVE'], 'filter_campaign_type': ['AMAZON-SPONSORED-BRANDS'], 'filter_click_through_rate_ge': 3.91, 'filter_click_through_rate_le': 9.53, 'filter_clicks_ge': 6848626767, 'filter_clicks_le': 4787837344, 'filter_conversion_rate_adjusted_ge': 2.14, 'filter_conversion_rate_adjusted_le': 5.88, 'filter_conversion_rate_ge': 6.44, 'filter_conversion_rate_le': 7.8, 'filter_conversions_adjusted_ge': 14.26, 'filter_conversions_adjusted_le': 0.41, 'filter_conversions_ge': 8.67, 'filter_conversions_le': 10.95, 'filter_cost_ge': 4630000, 'filter_cost_le': 3590000, 'filter_cost_optimization_type_click_ge': 8700000, 'filter_cost_optimization_type_click_le': 3880000, 'filter_cost_optimization_type_profit_ge': 9930000, 'filter_cost_optimization_type_profit_le': 7860000, 'filter_cost_optimization_type_revenue_ge': 8310000, 'filter_cost_optimization_type_revenue_le': 6530000, 'filter_cost_per_click_ge': 6110000, 'filter_cost_per_click_le': 6500000, 'filter_cost_per_conversion_adjusted_ge': 5290000, 'filter_cost_per_conversion_adjusted_le': 2350000, 'filter_cost_per_conversion_ge': 9650000, 'filter_cost_per_conversion_le': 9820000, 'filter_cost_revenue_ratio_adjusted_ge': 0.62, 'filter_cost_revenue_ratio_adjusted_le': 11.89, 'filter_cost_revenue_ratio_ge': 4.23, 'filter_cost_revenue_ratio_le': 7.67, 'filter_date_ge': '2018-10-21', 'filter_date_le': '2018-10-21', 'filter_impressions_ge': 2586369292, 'filter_impressions_le': 1895730553, 'filter_performance_group_enabled': [True], 'filter_performance_group_goal_types': ['CLICKS-PER-DAY'], 'filter_performance_group_id': [6668648308], 'filter_performance_group_name': ['dolor sit'], 'filter_performance_group_optimization_type': ['CLICK'], 'filter_profit_adjusted_ge': 4990000, 'filter_profit_adjusted_le': 5320000, 'filter_profit_ge': 1400000, 'filter_profit_gross_adjusted_ge': 7970000, 'filter_profit_gross_adjusted_le': 8130000, 'filter_profit_gross_ge': 7910000, 'filter_profit_gross_le': 9520000, 'filter_profit_le': 7930000, 'filter_profit_net_adjusted_ge': 7160000, 'filter_profit_net_adjusted_le': 8470000, 'filter_profit_net_ge': 8640000, 'filter_profit_net_le': 7290000, 'filter_return_on_ad_spend_adjusted_ge': 14.05, 'filter_return_on_ad_spend_adjusted_le': 6.06, 'filter_return_on_ad_spend_ge': 18.33, 'filter_return_on_ad_spend_le': 11.53, 'filter_return_on_investment_adjusted_ge': 2.03, 'filter_return_on_investment_adjusted_le': 7.11, 'filter_return_on_investment_ge': 1.24, 'filter_return_on_investment_le': 5.79, 'filter_revenue_adjusted_ge': 7810000, 'filter_revenue_adjusted_le': 7490000, 'filter_revenue_ge': 8770000, 'filter_revenue_le': 440000, 'group_by': 'ACCOUNT', 'include': ['ipsum.amet'], 'limit': 10, 'offset': 0, 'search_account_id': 'elit dolor', 'search_account_name': 'sit tucan', 'search_account_tags_user': 'dolor elit', 'search_adspert_account_id': 'dolor vehicula', 'search_amz_portfolio_id': 'tucan adlora', 'search_amz_portfolio_name': 'lorem tucan', 'search_campaign_id': 'dolor amet', 'search_campaign_labels': 'dolor ipsum', 'search_campaign_name': 'lorem tucan', 'search_fields': ['pariatur.adlora'], 'search_performance_group_id': 'ipsum lorem', 'search_performance_group_name': 'tucan lorem', 'search_term': 'vehicula ipsum', 'sort_account_id': 7, 'sort_account_is_demo': -6, 'sort_account_name': 5, 'sort_account_optimize': 0, 'sort_account_platform': 3, 'sort_adspert_account_id': -2, 'sort_adspert_campaign_id': 9, 'sort_adspert_portfolio_id': -8, 'sort_amz_portfolio_id': -2, 'sort_amz_portfolio_name': -6, 'sort_campaign_eby_marketplace_id': 3, 'sort_campaign_id': 9, 'sort_campaign_name': 5, 'sort_campaign_optimization_support': 0, 'sort_campaign_optimization_type': -4, 'sort_campaign_optimize': 7, 'sort_campaign_status': -6, 'sort_campaign_type': -6, 'sort_click_through_rate': -8, 'sort_clicks': 1, 'sort_conversion_rate': 5, 'sort_conversion_rate_adjusted': 3, 'sort_conversions': 9, 'sort_conversions_adjusted': -6, 'sort_conversions_for_revenue': -4, 'sort_conversions_for_revenue_adjusted': -2, 'sort_cost': -8, 'sort_cost_for_click': -8, 'sort_cost_for_organic': 3, 'sort_cost_for_organic_rolling_avg': -2, 'sort_cost_for_profit': -6, 'sort_cost_for_revenue': -4, 'sort_cost_optimization_type_click': -4, 'sort_cost_optimization_type_profit': 5, 'sort_cost_optimization_type_revenue': 0, 'sort_cost_per_click': -4, 'sort_cost_per_conversion': 3, 'sort_cost_per_conversion_adjusted': 0, 'sort_cost_revenue_ratio': -2, 'sort_cost_revenue_ratio_adjusted': -2, 'sort_cost_revenue_total_ratio': 3, 'sort_cost_revenue_total_ratio_rolling_avg': 5, 'sort_date': -6, 'sort_impressions': 1, 'sort_performance_group_enabled': 7, 'sort_performance_group_goal_types': 7, 'sort_performance_group_id': 7, 'sort_performance_group_name': -6, 'sort_performance_group_optimization_type': 1, 'sort_profit': -2, 'sort_profit_adjusted': 5, 'sort_profit_gross': -8, 'sort_profit_gross_adjusted': 9, 'sort_profit_net': 9, 'sort_profit_net_adjusted': 1, 'sort_return_on_ad_spend': -4, 'sort_return_on_ad_spend_adjusted': -4, 'sort_return_on_investment': 0, 'sort_return_on_investment_adjusted': 3, 'sort_revenue': 1, 'sort_revenue_adjusted': -8, 'sort_revenue_organic': 3, 'sort_revenue_organic_adjusted': 1, 'sort_revenue_per_conversion': 3, 'sort_revenue_per_conversion_adjusted': -4, 'sort_revenue_total': -6, 'sort_revenue_total_rolling_avg': 1})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "date": "2018-10-21",
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "account_optimize": true,
      "account_tags_user": [
        "vehicula amet"
      ],
      "account_is_demo": true,
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_enabled": true,
      "performance_group_optimization_type": "CLICK",
      "performance_group_goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "performance_group_platforms": [
        "AMAZON"
      ],
      "performance_group_user_max_bid": {
        "micros": 8340000,
        "currency": "AED"
      },
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "campaign_eby_marketplace_id": "amet pariatur",
      "campaign_status": "ACTIVE",
      "campaign_optimize": true,
      "campaign_optimization_type": "CLICK",
      "campaign_optimization_support": "SUPPORTED",
      "campaign_labels": [
        "ipsum dolor"
      ],
      "campaign_user_max_bid": {
        "micros": 8340000,
        "currency": "AED"
      },
      "impressions": 2157218327,
      "clicks": 5857268080,
      "conversions": 3.92,
      "conversions_adjusted": 18.15,
      "conversions_for_revenue": 4.57,
      "conversions_for_revenue_adjusted": 4.9,
      "profit": 9510000,
      "profit_adjusted": 2710000,
      "profit_gross": 6420000,
      "profit_gross_adjusted": 9200000,
      "profit_net": 30000,
      "profit_net_adjusted": 3540000,
      "revenue": 360000,
      "revenue_adjusted": 9120000,
      "revenue_total": 9370000,
      "revenue_total_rolling_avg": 2650000,
      "revenue_organic": 2410000,
      "revenue_organic_adjusted": 3080000,
      "cost": 4540000,
      "cost_optimization_type_click": 7130000,
      "cost_optimization_type_profit": 8820000,
      "cost_optimization_type_revenue": 820000,
      "cost_for_profit": 800000,
      "cost_for_revenue": 6910000,
      "cost_for_click": 6810000,
      "cost_for_organic": 3360000,
      "cost_for_organic_rolling_avg": 4530000,
      "cost_per_click": 7300000,
      "cost_per_conversion": 7570000,
      "cost_per_conversion_adjusted": 340000,
      "conversion_rate": 0.86,
      "conversion_rate_adjusted": 4.8,
      "click_through_rate": 7.58,
      "return_on_investment": 3.28,
      "return_on_investment_adjusted": 1.3,
      "return_on_ad_spend": 2.29,
      "return_on_ad_spend_adjusted": 8.05,
      "cost_revenue_ratio": 16.41,
      "cost_revenue_ratio_adjusted": 10.14,
      "cost_revenue_total_ratio": 9.0,
      "cost_revenue_total_ratio_rolling_avg": 18.81,
      "revenue_per_conversion": 7070000,
      "revenue_per_conversion_adjusted": 4550000
    }
  ],
  "meta": {}
}

ProductPerformanceCollection

GET

GET /v3/preview/accounts/(adspert_account_id: int)/performance/products

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where date is on or after this date.
filter_date_le required	Date	Only return results where date is on or before this date.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_adspert_adgroup_id	[ CompositeID ]	Only return results matching given adspert_adgroup_id values.
filter_adgroup_id	[ LargeInteger ]	Only return results matching given adgroup_id values.
filter_adgroup_name	[ String ]	Only return results matching given adgroup_name values.
filter_adgroup_status	[ AdgroupStatus ]	Only return results matching given adgroup_status values.
filter_adgroup_labels	[ String ]	Only return results matching given adgroup_labels values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_campaign_id	[ LargeInteger ]	Only return results matching given campaign_id values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_id	[ LargeInteger ]	Only return results matching given amz_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_adspert_product_id	[ String ]	Only return results matching given adspert_product_id values.
filter_amz_asin	[ String ]	Only return results matching given amz_asin values.
filter_amz_effective_status	[ ProductEffectiveStatus ]	Only return results matching given amz_effective_status values.
filter_amz_sku	[ String ]	Only return results matching given amz_sku values.
filter_eby_listing_id	[ String ]	Only return results matching given eby_listing_id values.
filter_ggl_offer_id	[ String ]	Only return results matching given ggl_offer_id values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_performance_group_id	Integer	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
search_adgroup_id	Integer	Only return results where adgroup_id matches the given string.
search_adgroup_name	String	Only return results where adgroup_name matches the given string.
search_adgroup_labels	String	Only return results where adgroup_labels matches the given string.
search_campaign_id	Integer	Only return results where campaign_id matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_amz_portfolio_id	Integer	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_amz_asin	String	Only return results where amz_asin matches the given string.
search_amz_sku	String	Only return results where amz_sku matches the given string.
search_eby_listing_id	String	Only return results where eby_listing_id matches the given string.
search_ggl_offer_id	String	Only return results where ggl_offer_id matches the given string.
search_title	String	Only return results where title matches the given string.
sort_adspert_product_id	SortDirective	Sort results by adspert_product_id.
sort_amz_asin	SortDirective	Sort results by amz_asin.
sort_amz_effective_status	SortDirective	Sort results by amz_effective_status.
sort_amz_sku	SortDirective	Sort results by amz_sku.
sort_click_through_rate	SortDirective	Sort results by click_through_rate.
sort_clicks	SortDirective	Sort results by clicks.
sort_conversion_rate	SortDirective	Sort results by conversion_rate.
sort_conversions	SortDirective	Sort results by conversions.
sort_conversions_for_revenue	SortDirective	Sort results by conversions_for_revenue.
sort_cost	SortDirective	Sort results by cost.
sort_cost_for_click	SortDirective	Sort results by cost_for_click.
sort_cost_for_profit	SortDirective	Sort results by cost_for_profit.
sort_cost_for_revenue	SortDirective	Sort results by cost_for_revenue.
sort_cost_per_click	SortDirective	Sort results by cost_per_click.
sort_cost_per_conversion	SortDirective	Sort results by cost_per_conversion.
sort_cost_revenue_ratio	SortDirective	Sort results by cost_revenue_ratio.
sort_date	SortDirective	Sort results by date.
sort_eby_listing_id	SortDirective	Sort results by eby_listing_id.
sort_ggl_offer_id	SortDirective	Sort results by ggl_offer_id.
sort_image_url	SortDirective	Sort results by image_url.
sort_impressions	SortDirective	Sort results by impressions.
sort_price	SortDirective	Sort results by price.
sort_profit_gross	SortDirective	Sort results by profit_gross.
sort_profit_net	SortDirective	Sort results by profit_net.
sort_return_on_ad_spend	SortDirective	Sort results by return_on_ad_spend.
sort_return_on_investment	SortDirective	Sort results by return_on_investment.
sort_revenue	SortDirective	Sort results by revenue.
sort_revenue_per_conversion	SortDirective	Sort results by revenue_per_conversion.
sort_title	SortDirective	Sort results by title.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1
group_by required	GroupBy	Grouping/segementation level for the results.
currency required	Currency

Response Data (object list, json or csv or xlsx)

Name	Type	Description
date	Date	NULL when grouped by adspert_product_id.
adspert_product_id	String	Adspert’s unique product ID. NULL when grouped by date.
title searchable	String	Product title. NULL when grouped by date.
image_url	String	Product image URL. NULL when grouped by date.
price	Micros	Product price. NULL when grouped by date.
amz_effective_status	ProductEffectiveStatus	Effective status of Amazon product. This is an aggregate of serving statuses from (possibly) many product ads that use this product. NULL when grouped by date.
amz_asin searchable	String	Amazon ASIN. NULL when grouped by date.
amz_sku searchable	String	Amazon SKU. NULL when grouped by date.
ggl_offer_id searchable	String	Google Offer ID. NULL when grouped by date.
eby_listing_id searchable	String	eBay listing ID. NULL when grouped by date.
impressions	Integer	Number of impressions
clicks	Integer	Number of clicks
conversions	Float	Number of conversions. Always 0 for click optimized campaigns.
cost	Micros	Total ad spend / cost
revenue	Micros	Revenue/sales. Always 0 for click and profit optimized campaigns.
profit_gross	Micros	Gross profit. Always 0 for click and revenue optimized campaigns.
profit_net	Micros	Net profit. profit_gross - cost_for_profit Always 0 for click and revenue optimized campaigns.
cost_per_click	Micros	Effective CPC. cost / clicks NULL if number of clicks is 0.
cost_per_conversion	Micros	Cost per conversion. Only cost for profit and revenue optimized campaigns is included. (cost - cost_for_click) / conversions NULL if number of conversions is 0.
cost_for_profit	Micros	Ad spend from campaigns that support profit. Always 0 for campaigns that don’t support profit.
cost_for_click	Micros	Ad spend / cost from click optimized campaigns. Always 0 for revenue and profit optimized campaigns.
cost_for_revenue	Micros	Ad spend from campaigns that support revenue. Always 0 for campaigns that don’t support revenue.
conversion_rate	Float	Conversion rate. conversions / clicks NULL if number of clicks is 0.
conversions_for_revenue	Float	Number of conversions for campaigns that support revenues. Always 0 for campaigns that don’t support revenue.
revenue_per_conversion	Micros	Revenue per conversions. Only revenue and conversions for revenue supporting campaigns are included. revenue / conversions_for_revenue NULL if campaign doesn’t support revenue.
click_through_rate	Float	Clickthrough rate (CTR). clicks / impressions NULL if number of impressions is 0.
return_on_investment	Float	Return on investment (ROI). Only cost for profit optimized campaigns is included. profit_gross / cost_for_profit NULL if cost_for_profit is 0.
return_on_ad_spend	Float	Return on ad spend (ROAS). Only cost for revenue optimized campaigns is included. revenue / cost_for_revenue NULL if cost_for_revenue is 0.
cost_revenue_ratio	Float	Cost Revenue Ratio (CRR). Also called Advertising Cost of Sale (ACoS). Only cost for revenue optimized campaigns is included. cost_for_revenue / revenue NULL if revenue is 0.

Example

http

GET /v3/preview/accounts/3420379091/performance/products?filter_campaign_optimization_type=CLICK&search_adgroup_name=adlora+ipsum&filter_amz_sku=adlora+lorem HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/preview/accounts/3420379091/performance/products?filter_campaign_optimization_type=CLICK&search_adgroup_name=adlora+ipsum&filter_amz_sku=adlora+lorem' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/preview/accounts/3420379091/performance/products?filter_campaign_optimization_type=CLICK&search_adgroup_name=adlora+ipsum&filter_amz_sku=adlora+lorem' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/preview/accounts/3420379091/performance/products?filter_campaign_optimization_type=CLICK&search_adgroup_name=adlora+ipsum&filter_amz_sku=adlora+lorem', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "date": null,
      "adspert_product_id": "B0100000000|000-000-001",
      "title": "Product XYZ",
      "image_url": "https://example.com/B0100000000.jpg",
      "price": "9990000",
      "amz_effective_status": "ACTIVE",
      "amz_asin": "B0100000000",
      "amz_sku": "000-000-001",
      "ggl_offer_id": "12345678",
      "eby_listing_id": "12345678",
      "impressions": 2157218327,
      "clicks": 5857268080,
      "conversions": 3.92,
      "cost": 4540000,
      "revenue": 360000,
      "profit_gross": 6420000,
      "profit_net": 30000,
      "cost_per_click": 7300000,
      "cost_per_conversion": 7570000,
      "cost_for_profit": 800000,
      "cost_for_click": 6810000,
      "cost_for_revenue": 6910000,
      "conversion_rate": 0.86,
      "conversions_for_revenue": 4.57,
      "revenue_per_conversion": 7070000,
      "click_through_rate": 7.58,
      "return_on_investment": 3.28,
      "return_on_ad_spend": 2.29,
      "cost_revenue_ratio": 16.41
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "date": 1
      }
    }
  }
}

ProductCampaignPerformanceCollection

GET

GET /v3/preview/accounts/(adspert_account_id: int)/performance/products/(adspert_product_id: b32)/campaigns

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where date is on or after this date.
filter_date_le required	Date	Only return results where date is on or before this date.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_effective_status	[ ProductEffectiveStatus ]	Only return results matching given amz_effective_status values.
filter_amz_portfolio_id	[ LargeInteger ]	Only return results matching given amz_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_id	[ LargeInteger ]	Only return results matching given campaign_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_campaign_type	SortDirective	Sort results by amz_campaign_type.
sort_amz_effective_status	SortDirective	Sort results by amz_effective_status.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_amz_targeting_type	SortDirective	Sort results by amz_targeting_type.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_support	SortDirective	Sort results by campaign_optimization_support.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_status	SortDirective	Sort results by campaign_status.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_click_through_rate	SortDirective	Sort results by click_through_rate.
sort_clicks	SortDirective	Sort results by clicks.
sort_conversion_rate	SortDirective	Sort results by conversion_rate.
sort_conversions	SortDirective	Sort results by conversions.
sort_conversions_for_revenue	SortDirective	Sort results by conversions_for_revenue.
sort_cost	SortDirective	Sort results by cost.
sort_cost_for_click	SortDirective	Sort results by cost_for_click.
sort_cost_for_profit	SortDirective	Sort results by cost_for_profit.
sort_cost_for_revenue	SortDirective	Sort results by cost_for_revenue.
sort_cost_per_click	SortDirective	Sort results by cost_per_click.
sort_cost_per_conversion	SortDirective	Sort results by cost_per_conversion.
sort_cost_revenue_ratio	SortDirective	Sort results by cost_revenue_ratio.
sort_date	SortDirective	Sort results by date.
sort_eby_campaign_type	SortDirective	Sort results by eby_campaign_type.
sort_ggl_campaign_type	SortDirective	Sort results by ggl_campaign_type.
sort_impressions	SortDirective	Sort results by impressions.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
sort_price	SortDirective	Sort results by price.
sort_profit_gross	SortDirective	Sort results by profit_gross.
sort_profit_net	SortDirective	Sort results by profit_net.
sort_return_on_ad_spend	SortDirective	Sort results by return_on_ad_spend.
sort_return_on_investment	SortDirective	Sort results by return_on_investment.
sort_revenue	SortDirective	Sort results by revenue.
sort_revenue_per_conversion	SortDirective	Sort results by revenue_per_conversion.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1
group_by required	GroupBy	Grouping/segmentation level for the results.
currency required	Currency

Response Data (object list, json or csv or xlsx)

Name	Type	Description
date	Date	NULL when grouped by campaign_id.
amz_effective_status	ProductEffectiveStatus	Effective status of Amazon product. NULL when grouped by date.
amz_targeting_type	AmzTargetingType	Amazon campaign targeting type. NULL when grouped by date.
performance_group_id searchable	Integer	Unique ID of the performance group NULL when grouped by date.
performance_group_name searchable	String	Unique name of the performance group. NULL when grouped by date.
performance_group_enabled	Boolean	NULL when grouped by date.
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group. NULL when grouped by date.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types NULL when grouped by date.
price	Micros	Price of the product. Current price When grouped by campaign_id. Historical prices when grouped by date.
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. NULL when grouped by date. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger	NULL when grouped by date.
campaign_name searchable	String	NULL when grouped by date.
campaign_type	CampaignType	NULL when grouped by date.
campaign_eby_marketplace_id	String	NULL when grouped by date.
campaign_status	CampaignStatus	NULL when grouped by date.
campaign_optimize	Boolean	NULL when grouped by date.
campaign_optimization_type	OptimizationType	NULL when grouped by date.
campaign_optimization_support	CampaignOptimizationSupport	NULL when grouped by date.
campaign_labels searchable	[ String ]	NULL when grouped by date.
amz_campaign_type	AmzCampaignType	Amazon campaign type. NULL when grouped by date. DEPRECATED: Use campaign_type instead.
ggl_campaign_type	AwCampaignType	Google Ads campaign type. NULL when grouped by date. DEPRECATED: Use campaign_type instead.
eby_campaign_type	EbayCampaignType	eBay campaign type. NULL when grouped by date. DEPRECATED: Use campaign_type instead.
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. NULL when grouped by date. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger	NULL when grouped by date.
amz_portfolio_name searchable	String	NULL when grouped by date.
impressions	Integer	Number of impressions
clicks	Integer	Number of clicks
conversions	Float	Number of conversions. Always 0 for click optimized campaigns.
cost	Micros	Total ad spend / cost
revenue	Micros	Revenue/sales. Always 0 for click and profit optimized campaigns.
profit_gross	Micros	Gross profit. Always 0 for click and revenue optimized campaigns.
profit_net	Micros	Net profit. profit_gross - cost_for_profit Always 0 for click and revenue optimized campaigns.
cost_per_click	Micros	Effective CPC. cost / clicks NULL if number of clicks is 0.
cost_per_conversion	Micros	Cost per conversion. Only cost for profit and revenue optimized campaigns is included. (cost - cost_for_click) / conversions NULL if number of conversions is 0.
cost_for_profit	Micros	Ad spend from campaigns that support profit. Always 0 for campaigns that don’t support profit.
cost_for_click	Micros	Ad spend / cost from click optimized campaigns. Always 0 for revenue and profit optimized campaigns.
cost_for_revenue	Micros	Ad spend from campaigns that support revenue. Always 0 for campaigns that don’t support revenue.
conversion_rate	Float	Conversion rate. conversions / clicks NULL if number of clicks is 0.
conversions_for_revenue	Float	Number of conversions for campaigns that support revenues. Always 0 for campaigns that don’t support revenue.
revenue_per_conversion	Micros	Revenue per conversions. Only revenue and conversions for revenue supporting campaigns are included. revenue / conversions_for_revenue NULL if campaign doesn’t support revenue.
click_through_rate	Float	Clickthrough rate (CTR). clicks / impressions NULL if number of impressions is 0.
return_on_investment	Float	Return on investment (ROI). Only cost for profit optimized campaigns is included. profit_gross / cost_for_profit NULL if cost_for_profit is 0.
return_on_ad_spend	Float	Return on ad spend (ROAS). Only cost for revenue optimized campaigns is included. revenue / cost_for_revenue NULL if cost_for_revenue is 0.
cost_revenue_ratio	Float	Cost Revenue Ratio (CRR). Also called Advertising Cost of Sale (ACoS). Only cost for revenue optimized campaigns is included. cost_for_revenue / revenue NULL if revenue is 0.

Example

http

GET /v3/preview/accounts/3420379091/performance/products/JFCC2MJSGM2A====/campaigns?sort_performance_group_enabled=7&sort_conversions_for_revenue=-4&sort_profit_net=9 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/preview/accounts/3420379091/performance/products/JFCC2MJSGM2A====/campaigns?sort_performance_group_enabled=7&sort_conversions_for_revenue=-4&sort_profit_net=9' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/preview/accounts/3420379091/performance/products/JFCC2MJSGM2A====/campaigns?sort_performance_group_enabled=7&sort_conversions_for_revenue=-4&sort_profit_net=9' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/preview/accounts/3420379091/performance/products/JFCC2MJSGM2A====/campaigns?sort_performance_group_enabled=7&sort_conversions_for_revenue=-4&sort_profit_net=9', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "date": null,
      "amz_effective_status": "ACTIVE",
      "amz_targeting_type": "AUTO",
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_enabled": true,
      "performance_group_optimization_type": "CLICK",
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "price": 1910000,
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "campaign_eby_marketplace_id": "amet pariatur",
      "campaign_status": "ACTIVE",
      "campaign_optimize": true,
      "campaign_optimization_type": "CLICK",
      "campaign_optimization_support": "SUPPORTED",
      "campaign_labels": [
        "ipsum dolor"
      ],
      "amz_campaign_type": "SPONSOREDBRANDS",
      "ggl_campaign_type": "DISCOVERY",
      "eby_campaign_type": "PROMOTED-LISTINGS-ADVANCED",
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "impressions": 2157218327,
      "clicks": 5857268080,
      "conversions": 3.92,
      "cost": 4540000,
      "revenue": 360000,
      "profit_gross": 6420000,
      "profit_net": 30000,
      "cost_per_click": 7300000,
      "cost_per_conversion": 7570000,
      "cost_for_profit": 800000,
      "cost_for_click": 6810000,
      "cost_for_revenue": 6910000,
      "conversion_rate": 0.86,
      "conversions_for_revenue": 4.57,
      "revenue_per_conversion": 7070000,
      "click_through_rate": 7.58,
      "return_on_investment": 3.28,
      "return_on_ad_spend": 2.29,
      "cost_revenue_ratio": 16.41
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "date": 1
      }
    }
  }
}

ProductAdGroupPerformanceCollection

GET

GET /v3/preview/accounts/(adspert_account_id: int)/performance/products/(adspert_product_id: b32)/adgroups

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where date is on or after this date.
filter_date_le required	Date	Only return results where date is on or before this date.
filter_adgroup_id	[ LargeInteger ]	Only return results matching given adgroup_id values.
filter_adgroup_labels	[ String ]	Only return results matching given adgroup_labels values.
filter_adgroup_name	[ String ]	Only return results matching given adgroup_name values.
filter_adgroup_status	[ AdgroupStatus ]	Only return results matching given adgroup_status values.
filter_adspert_adgroup_id	[ CompositeID ]	Only return results matching given adspert_adgroup_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_effective_status	[ ProductEffectiveStatus ]	Only return results matching given amz_effective_status values.
filter_amz_portfolio_id	[ LargeInteger ]	Only return results matching given amz_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_id	[ LargeInteger ]	Only return results matching given campaign_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_adgroup_id	String	Only return results where adgroup_id matches the given string.
search_adgroup_labels	String	Only return results where adgroup_labels matches the given string.
search_adgroup_name	String	Only return results where adgroup_name matches the given string.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
sort_adgroup_id	SortDirective	Sort results by adgroup_id.
sort_adgroup_name	SortDirective	Sort results by adgroup_name.
sort_adgroup_status	SortDirective	Sort results by adgroup_status.
sort_adspert_adgroup_id	SortDirective	Sort results by adspert_adgroup_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_adgroup_type	SortDirective	Sort results by amz_adgroup_type.
sort_amz_effective_status	SortDirective	Sort results by amz_effective_status.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_support	SortDirective	Sort results by campaign_optimization_support.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_status	SortDirective	Sort results by campaign_status.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_click_through_rate	SortDirective	Sort results by click_through_rate.
sort_clicks	SortDirective	Sort results by clicks.
sort_conversion_rate	SortDirective	Sort results by conversion_rate.
sort_conversions	SortDirective	Sort results by conversions.
sort_conversions_for_revenue	SortDirective	Sort results by conversions_for_revenue.
sort_cost	SortDirective	Sort results by cost.
sort_cost_for_click	SortDirective	Sort results by cost_for_click.
sort_cost_for_profit	SortDirective	Sort results by cost_for_profit.
sort_cost_for_revenue	SortDirective	Sort results by cost_for_revenue.
sort_cost_per_click	SortDirective	Sort results by cost_per_click.
sort_cost_per_conversion	SortDirective	Sort results by cost_per_conversion.
sort_cost_revenue_ratio	SortDirective	Sort results by cost_revenue_ratio.
sort_date	SortDirective	Sort results by date.
sort_impressions	SortDirective	Sort results by impressions.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
sort_price	SortDirective	Sort results by price.
sort_profit_gross	SortDirective	Sort results by profit_gross.
sort_profit_net	SortDirective	Sort results by profit_net.
sort_return_on_ad_spend	SortDirective	Sort results by return_on_ad_spend.
sort_return_on_investment	SortDirective	Sort results by return_on_investment.
sort_revenue	SortDirective	Sort results by revenue.
sort_revenue_per_conversion	SortDirective	Sort results by revenue_per_conversion.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1
group_by required	GroupBy	Grouping/segementation level for the results.
currency required	Currency

Response Data (object list, json or csv or xlsx)

Name	Type	Description
date	Date	NULL when grouped by adgroup_id.
amz_effective_status	ProductEffectiveStatus	Effective status of Amazon product. NULL when grouped by date.
amz_adgroup_type	AmzAdGroupType	Amazon Ad Group type. NULL when grouped by date.
performance_group_id searchable	Integer	Unique ID of the performance group NULL when grouped by date.
performance_group_name searchable	String	Unique name of the performance group. NULL when grouped by date.
performance_group_enabled	Boolean	NULL when grouped by date.
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group. NULL when grouped by date.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types NULL when grouped by date.
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. NULL when grouped by date. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger	NULL when grouped by date.
campaign_name searchable	String	NULL when grouped by date.
campaign_type	CampaignType	NULL when grouped by date.
price	Micros	Price of the product. Current price When grouped by adgroup_id. Historical prices when grouped by date.
campaign_eby_marketplace_id	String	NULL when grouped by date.
campaign_status	CampaignStatus	NULL when grouped by date.
campaign_optimize	Boolean	NULL when grouped by date.
campaign_optimization_type	OptimizationType	NULL when grouped by date.
campaign_optimization_support	CampaignOptimizationSupport	NULL when grouped by date.
campaign_labels searchable	[ String ]	NULL when grouped by date.
adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. NULL when grouped by date. Composite ID specification: {adspert_account_id}:{adgroup_id}
adgroup_id searchable	LargeInteger	NULL when grouped by date.
adgroup_name searchable	String	NULL when grouped by date.
adgroup_status	AdgroupStatus	NULL when grouped by date.
adgroup_labels searchable	[ String ]	NULL when grouped by date.
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. NULL when grouped by date. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger	NULL when grouped by date.
amz_portfolio_name searchable	String	NULL when grouped by date.
impressions	Integer	Number of impressions
clicks	Integer	Number of clicks
conversions	Float	Number of conversions. Always 0 for click optimized campaigns.
cost	Micros	Total ad spend / cost
revenue	Micros	Revenue/sales. Always 0 for click and profit optimized campaigns.
profit_gross	Micros	Gross profit. Always 0 for click and revenue optimized campaigns.
profit_net	Micros	Net profit. profit_gross - cost_for_profit Always 0 for click and revenue optimized campaigns.
cost_per_click	Micros	Effective CPC. cost / clicks NULL if number of clicks is 0.
cost_per_conversion	Micros	Cost per conversion. Only cost for profit and revenue optimized campaigns is included. (cost - cost_for_click) / conversions NULL if number of conversions is 0.
cost_for_profit	Micros	Ad spend from campaigns that support profit. Always 0 for campaigns that don’t support profit.
cost_for_click	Micros	Ad spend / cost from click optimized campaigns. Always 0 for revenue and profit optimized campaigns.
cost_for_revenue	Micros	Ad spend from campaigns that support revenue. Always 0 for campaigns that don’t support revenue.
conversion_rate	Float	Conversion rate. conversions / clicks NULL if number of clicks is 0.
conversions_for_revenue	Float	Number of conversions for campaigns that support revenues. Always 0 for campaigns that don’t support revenue.
revenue_per_conversion	Micros	Revenue per conversions. Only revenue and conversions for revenue supporting campaigns are included. revenue / conversions_for_revenue NULL if campaign doesn’t support revenue.
click_through_rate	Float	Clickthrough rate (CTR). clicks / impressions NULL if number of impressions is 0.
return_on_investment	Float	Return on investment (ROI). Only cost for profit optimized campaigns is included. profit_gross / cost_for_profit NULL if cost_for_profit is 0.
return_on_ad_spend	Float	Return on ad spend (ROAS). Only cost for revenue optimized campaigns is included. revenue / cost_for_revenue NULL if cost_for_revenue is 0.
cost_revenue_ratio	Float	Cost Revenue Ratio (CRR). Also called Advertising Cost of Sale (ACoS). Only cost for revenue optimized campaigns is included. cost_for_revenue / revenue NULL if revenue is 0.

Example

http

GET /v3/preview/accounts/3420379091/performance/products/JFCC2MJSGM2A====/adgroups?sort_cost_per_conversion=3&sort_revenue_per_conversion=3&sort_amz_portfolio_name=-6 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/preview/accounts/3420379091/performance/products/JFCC2MJSGM2A====/adgroups?sort_cost_per_conversion=3&sort_revenue_per_conversion=3&sort_amz_portfolio_name=-6' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/preview/accounts/3420379091/performance/products/JFCC2MJSGM2A====/adgroups?sort_cost_per_conversion=3&sort_revenue_per_conversion=3&sort_amz_portfolio_name=-6' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/preview/accounts/3420379091/performance/products/JFCC2MJSGM2A====/adgroups?sort_cost_per_conversion=3&sort_revenue_per_conversion=3&sort_amz_portfolio_name=-6', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "date": null,
      "amz_effective_status": "ACTIVE",
      "amz_adgroup_type": "KEYWORD",
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_enabled": true,
      "performance_group_optimization_type": "CLICK",
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "price": 1910000,
      "campaign_eby_marketplace_id": "amet pariatur",
      "campaign_status": "ACTIVE",
      "campaign_optimize": true,
      "campaign_optimization_type": "CLICK",
      "campaign_optimization_support": "SUPPORTED",
      "campaign_labels": [
        "ipsum dolor"
      ],
      "adspert_adgroup_id": "123:777",
      "adgroup_id": "777",
      "adgroup_name": "tucan lorem",
      "adgroup_status": "ACTIVE",
      "adgroup_labels": [
        "elit ipsum"
      ],
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "impressions": 2157218327,
      "clicks": 5857268080,
      "conversions": 3.92,
      "cost": 4540000,
      "revenue": 360000,
      "profit_gross": 6420000,
      "profit_net": 30000,
      "cost_per_click": 7300000,
      "cost_per_conversion": 7570000,
      "cost_for_profit": 800000,
      "cost_for_click": 6810000,
      "cost_for_revenue": 6910000,
      "conversion_rate": 0.86,
      "conversions_for_revenue": 4.57,
      "revenue_per_conversion": 7070000,
      "click_through_rate": 7.58,
      "return_on_investment": 3.28,
      "return_on_ad_spend": 2.29,
      "cost_revenue_ratio": 16.41
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "date": 1
      }
    }
  }
}

ProductConvertingCriteriaCollection

GET

GET /v3/preview/accounts/(adspert_account_id: int)/products/(adspert_product_id: b32)/converting-criteria

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
sort_criterion_name	SortDirective	Sort results by criterion_name.
sort_criterion_type	SortDirective	Sort results by criterion_type.
sort_match_type	SortDirective	Sort results by match_type.
sort_share_of_conversions	SortDirective	Sort results by share_of_conversions.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
criterion_name	String	Criterion name.
criterion_type	ProductCriterionType	Criterion type.
match_type	CriterionMatchType	Keyword match type. NULL if criterion is not a keyword.
share_of_conversions	Float	Ratio of conversions this criterion has generated, to total number of conversions generated by all non-automatic criteria for this product.

Example

http

GET /v3/preview/accounts/3420379091/products/JFCC2MJSGM2A====/converting-criteria?sort_match_type=9&sort_criterion_type=0&offset=0 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/preview/accounts/3420379091/products/JFCC2MJSGM2A====/converting-criteria?sort_match_type=9&sort_criterion_type=0&offset=0' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/preview/accounts/3420379091/products/JFCC2MJSGM2A====/converting-criteria?sort_match_type=9&sort_criterion_type=0&offset=0' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/preview/accounts/3420379091/products/JFCC2MJSGM2A====/converting-criteria?sort_match_type=9&sort_criterion_type=0&offset=0', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "criterion_name": "dolor adlora",
      "criterion_type": "AUDIENCES",
      "match_type": "BROAD",
      "share_of_conversions": 18.28
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "criterion_name": 1
      }
    }
  }
}

ScenarioCollection

GET

GET /v3/customers/(customer_id: int)/scenarios

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1
performance_group_id	Integer	Performance group to create scenarios for. If adspert_campaign_ids is defined, those campaigns will be used instead of campaigns that are currently assigned to the performance group.
adspert_campaign_ids	[ CompositeID ]	List of campaigns to create scenarios for. All campaigns need to be of the same optimization_type.
currency required	Currency
goal_type	PerformanceGroupGoalType	Type of the goal to include in scenarios. Specifying goal_type, goal_value, and (optionally) goal_currency will add a scenario that matches the selected goal value. goal_type, goal_value and goal_currency should be NULL if performance_group_id is specified.
goal_value	Float	Value of the goal to include in scenarios. Specifying goal_type, goal_value, and (optionally) goal_currency will add a scenario that matches the selected goal value. goal_type, goal_value and goal_currency should be NULL if performance_group_id is specified.
goal_currency	Currency	Currency of the goal to include in scenarios. Specifying goal_type, goal_value, and (optionally) goal_currency will add a scenario that matches the selected goal value. goal_type, goal_value and goal_currency should be NULL if performance_group_id is specified. Currency is required for the following goal types: COST-PER-DAY, COST-PER-CONVERSION, COST-PER-CLICK.

Response Data (object list, json or csv or xlsx)

Name	Type	Description
clicks	Float	Number of projected clicks
conversions	Float	Number of projected conversions. Always None for click optimized performance groups and campaigns.
cost	Micros	Projected ad spend/cost.
revenue	Micros	Projected revenue/sales. Always None for click and profit optimized performance groups and campaigns.
profit_net	Micros	Projected net profit. Always None for click and revenue optimized performance groups and campaigns.
profit_gross	Micros	Projected gross profit. Always None for click and revenue optimized performance groups and campaigns.
cost_per_click	Micros	Projected effective CPC.
cost_per_conversion	Micros	Projected cost per conversion. Always None for click optimized performance groups and campaigns.
return_on_investment	Float	Projected return on investment (ROI). Always None for click and revenue optimized performance groups and campaigns.
return_on_ad_spend	Float	Projected return on ad spend (ROAS). Always None for click and profit optimized performance groups and campaigns.
cost_revenue_ratio	Float	Projected cost revenue ratio (CRR). Always None for click and profit optimized performance groups and campaigns.

Example

http

GET /v3/customers/7027038674/scenarios?goal_value=1.41&exclude=elit.amet&currency=AED HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/scenarios?goal_value=1.41&exclude=elit.amet&currency=AED' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/scenarios?goal_value=1.41&exclude=elit.amet&currency=AED' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/scenarios?goal_value=1.41&exclude=elit.amet&currency=AED', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "clicks": 10.56,
      "conversions": 3.92,
      "cost": 4540000,
      "revenue": 360000,
      "profit_net": 30000,
      "profit_gross": 6420000,
      "cost_per_click": 7300000,
      "cost_per_conversion": 7570000,
      "return_on_investment": 3.28,
      "return_on_ad_spend": 2.29,
      "cost_revenue_ratio": 16.41
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "clicks": 1
      }
    }
  }
}

POST

POST /v3/customers/(customer_id: int)/scenarios

Auth mode:

api-token

Access level:

user

Request Data (single object, json)

Name	Type	Description
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
performance_group_id	Integer	Performance group to create scenarios for. If adspert_campaign_ids is defined, those campaigns will be used instead of campaigns that are currently assigned to the performance group.
adspert_campaign_ids	[ CompositeID ]	List of campaigns to create scenarios for. All campaigns need to be of the same optimization_type.
currency required	Currency
goal_type	PerformanceGroupGoalType	Type of the goal to include in scenarios. Specifying goal_type, goal_value, and (optionally) goal_currency will add a scenario that matches the selected goal value. goal_type, goal_value and goal_currency should be NULL if performance_group_id is specified.
goal_value	Float	Value of the goal to include in scenarios. Specifying goal_type, goal_value, and (optionally) goal_currency will add a scenario that matches the selected goal value. goal_type, goal_value and goal_currency should be NULL if performance_group_id is specified.
goal_currency	Currency	Currency of the goal to include in scenarios. Specifying goal_type, goal_value, and (optionally) goal_currency will add a scenario that matches the selected goal value. goal_type, goal_value and goal_currency should be NULL if performance_group_id is specified. Currency is required for the following goal types: COST-PER-DAY, COST-PER-CONVERSION, COST-PER-CLICK.

Response Data (object list, json or csv or xlsx)

Name	Type	Description
clicks	Float	Number of projected clicks
conversions	Float	Number of projected conversions. Always None for click optimized performance groups and campaigns.
cost	Micros	Projected ad spend/cost.
revenue	Micros	Projected revenue/sales. Always None for click and profit optimized performance groups and campaigns.
profit_net	Micros	Projected net profit. Always None for click and revenue optimized performance groups and campaigns.
profit_gross	Micros	Projected gross profit. Always None for click and revenue optimized performance groups and campaigns.
cost_per_click	Micros	Projected effective CPC.
cost_per_conversion	Micros	Projected cost per conversion. Always None for click optimized performance groups and campaigns.
return_on_investment	Float	Projected return on investment (ROI). Always None for click and revenue optimized performance groups and campaigns.
return_on_ad_spend	Float	Projected return on ad spend (ROAS). Always None for click and profit optimized performance groups and campaigns.
cost_revenue_ratio	Float	Projected cost revenue ratio (CRR). Always None for click and profit optimized performance groups and campaigns.

Example

http

POST /v3/customers/7027038674/scenarios HTTP/1.1
Host: api.adspert.net
Accept: application/json
Content-Type: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

{
  "offset": 0,
  "limit": 10,
  "include": [
    "ipsum.amet"
  ],
  "exclude": [
    "elit.amet"
  ],
  "performance_group_id": "1245",
  "adspert_campaign_ids": [
    "123:5555"
  ],
  "currency": "AED",
  "goal_type": "CLICKS-PER-DAY",
  "goal_value": 1.41,
  "goal_currency": "AED"
}

curl

curl -i -X POST https://api.adspert.net/v3/customers/7027038674/scenarios -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..." --data-raw '{"adspert_campaign_ids": ["123:5555"], "currency": "AED", "exclude": ["elit.amet"], "goal_currency": "AED", "goal_type": "CLICKS-PER-DAY", "goal_value": 1.41, "include": ["ipsum.amet"], "limit": 10, "offset": 0, "performance_group_id": "1245"}'

httpie

echo '{
  "adspert_campaign_ids": [
    "123:5555"
  ],
  "currency": "AED",
  "exclude": [
    "elit.amet"
  ],
  "goal_currency": "AED",
  "goal_type": "CLICKS-PER-DAY",
  "goal_value": 1.41,
  "include": [
    "ipsum.amet"
  ],
  "limit": 10,
  "offset": 0,
  "performance_group_id": "1245"
}' | http POST https://api.adspert.net/v3/customers/7027038674/scenarios Accept:application/json Content-Type:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.post('https://api.adspert.net/v3/customers/7027038674/scenarios', headers={'Accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'}, json={'adspert_campaign_ids': ['123:5555'], 'currency': 'AED', 'exclude': ['elit.amet'], 'goal_currency': 'AED', 'goal_type': 'CLICKS-PER-DAY', 'goal_value': 1.41, 'include': ['ipsum.amet'], 'limit': 10, 'offset': 0, 'performance_group_id': '1245'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "clicks": 10.56,
      "conversions": 3.92,
      "cost": 4540000,
      "revenue": 360000,
      "profit_net": 30000,
      "profit_gross": 6420000,
      "cost_per_click": 7300000,
      "cost_per_conversion": 7570000,
      "return_on_investment": 3.28,
      "return_on_ad_spend": 2.29,
      "cost_revenue_ratio": 16.41
    }
  ],
  "meta": {}
}

Logs

PerformanceGroupLogCollection

GET

GET /v3/customers/(customer_id: int)/performance-groups/log

Get Performance Group Logs for respective customer.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_id	[ LargeInteger ]	Only return results matching given amz_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_entry_type	[ PerformanceGroupLogEntryType ]	Only return results matching given entry_type values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_user_id	[ Integer ]	Only return results matching given user_id values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_goal_name	String	Only return results where goal_name matches the given string.
search_performance_group_goal_types	String	Only return results where performance_group_goal_types matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_amz_portfolio_id	Integer	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_user_name	String	Only return results where user_name matches the given string.
search_user_email	String	Only return results where user_email matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_campaign_id	String	Only return results where campaign_id matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_campaign_id	SortDirective	Sort results by campaign_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_entry_type	SortDirective	Sort results by entry_type.
sort_log_id	SortDirective	Sort results by log_id.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_timestamp	SortDirective	Sort results by timestamp.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
timestamp	DateTime
log_id	Integer
user_id	Integer	-1 if change was made by Adspert.
user_email searchable	String	NULL if change was made by Adspert.
user_name searchable	String	Adspert if change was made by Adspert.
performance_group_id searchable	Integer	Unique ID of the performance group
performance_group_name searchable	String	Unique name of the performance group.
account_id searchable	String	Ad platform specific ID of an advertising account.
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_id searchable	LargeInteger
campaign_name searchable	String
entry_type	PerformanceGroupLogEntryType	Entry type of the respective Performance Group Log row.
message_title	String	Localized and human-readable message title for the respective Performance Group Log row.
message_details	String	Localized and human-readable message details for the respective Performance Group Log row.

Example

http

GET /v3/customers/7027038674/performance-groups/log?sort_adspert_campaign_id=9&filter_account_platform=AMAZON&search_campaign_name=lorem+tucan HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/performance-groups/log?sort_adspert_campaign_id=9&filter_account_platform=AMAZON&search_campaign_name=lorem+tucan' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/performance-groups/log?sort_adspert_campaign_id=9&filter_account_platform=AMAZON&search_campaign_name=lorem+tucan' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/performance-groups/log?sort_adspert_campaign_id=9&filter_account_platform=AMAZON&search_campaign_name=lorem+tucan', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "timestamp": "2018-10-21T16:45:23+02:00",
      "log_id": 5332652616,
      "user_id": 4034300999,
      "user_email": "amet tucan",
      "user_name": "adlora ipsum",
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "account_id": "amet lorem",
      "adspert_account_id": 123,
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "adspert_campaign_id": "123:5555",
      "campaign_id": "5555",
      "campaign_name": "sit ipsum",
      "entry_type": "ACCOUNT-DEFAULT-ADDED-ACCOUNT-MOVED",
      "message_title": "pariatur lorem",
      "message_details": "tucan sit"
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "timestamp": 1
      }
    }
  }
}

FilterUserCollectionPerformanceGroups

GET

GET /v3/customers/(customer_id: int)/performance-groups/log/users

Get users that can be used as filters in the log endpoint.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.

Response Data (object list, json or csv or xlsx)

Name	Type	Description
user_id	Integer	Adspert user is assigned -1
user_name	String
user_email	String

Example

http

GET /v3/customers/7027038674/performance-groups/log/users?exclude=elit.amet&filter_date_ge=2018-10-21&include=ipsum.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/performance-groups/log/users?exclude=elit.amet&filter_date_ge=2018-10-21&include=ipsum.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/performance-groups/log/users?exclude=elit.amet&filter_date_ge=2018-10-21&include=ipsum.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/performance-groups/log/users?exclude=elit.amet&filter_date_ge=2018-10-21&include=ipsum.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "user_id": 4034300999,
      "user_name": "adlora ipsum",
      "user_email": "amet tucan"
    }
  ],
  "meta": {}
}

PerformanceGroupLogEntryTypesCollection

GET

GET /v3/customers/(customer_id: int)/performance-groups/log/entry-types

Get entry type that can be used as filters in the

Performance Group Log endpoint

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.

Response Data (object list, json or csv or xlsx)

Name	Type	Description
entry_type	PerformanceGroupLogEntryType

Example

http

GET /v3/customers/7027038674/performance-groups/log/entry-types?filter_date_le=2018-10-21&filter_date_ge=2018-10-21&include=ipsum.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/performance-groups/log/entry-types?filter_date_le=2018-10-21&filter_date_ge=2018-10-21&include=ipsum.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/performance-groups/log/entry-types?filter_date_le=2018-10-21&filter_date_ge=2018-10-21&include=ipsum.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/performance-groups/log/entry-types?filter_date_le=2018-10-21&filter_date_ge=2018-10-21&include=ipsum.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "entry_type": "ACCOUNT-DEFAULT-ADDED-ACCOUNT-MOVED"
    }
  ],
  "meta": {}
}

ProductAdSyncLogCollection

GET

GET /v3/customers/(customer_id: int)/product-ax/log/sync

Get product ad sync log for respective customer.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_account_currency	[ String ]	Only return results matching given account_currency values.
filter_source_performance_group_id	[ Integer ]	Only return results matching given source_performance_group_id values.
filter_source_performance_group_name	[ String ]	Only return results matching given source_performance_group_name values.
filter_source_performance_group_enabled	[ Boolean ]	Only return results matching given source_performance_group_enabled values.
filter_source_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given source_performance_group_optimization_type values.
filter_source_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given source_performance_group_goal_types values.
filter_target_performance_group_id	[ Integer ]	Only return results matching given target_performance_group_id values.
filter_target_performance_group_name	[ String ]	Only return results matching given target_performance_group_name values.
filter_target_performance_group_enabled	[ Boolean ]	Only return results matching given target_performance_group_enabled values.
filter_target_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given target_performance_group_optimization_type values.
filter_target_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given target_performance_group_goal_types values.
filter_source_adspert_portfolio_id	[ CompositeID ]	Only return results matching given source_adspert_portfolio_id values.
filter_source_amz_portfolio_id	[ LargeInteger ]	Only return results matching given source_amz_portfolio_id values.
filter_source_amz_portfolio_name	[ String ]	Only return results matching given source_amz_portfolio_name values.
filter_target_adspert_portfolio_id	[ CompositeID ]	Only return results matching given target_adspert_portfolio_id values.
filter_target_amz_portfolio_id	[ LargeInteger ]	Only return results matching given target_amz_portfolio_id values.
filter_target_amz_portfolio_name	[ String ]	Only return results matching given target_amz_portfolio_name values.
filter_source_campaign_type	[ CampaignType ]	Only return results matching given source_campaign_type values.
filter_source_campaign_eby_marketplace_id	[ String ]	Only return results matching given source_campaign_eby_marketplace_id values.
filter_source_campaign_status	[ CampaignStatus ]	Only return results matching given source_campaign_status values.
filter_source_campaign_optimize	[ Boolean ]	Only return results matching given source_campaign_optimize values.
filter_source_campaign_optimization_type	[ OptimizationType ]	Only return results matching given source_campaign_optimization_type values.
filter_source_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given source_campaign_optimization_support values.
filter_source_campaign_amz_targeting_type	[ AmzTargetingType ]	Only return results matching given source_campaign_amz_targeting_type values.
filter_source_campaign_labels	[ String ]	Only return results matching given source_campaign_labels values.
filter_target_campaign_type	[ CampaignType ]	Only return results matching given target_campaign_type values.
filter_target_campaign_eby_marketplace_id	[ String ]	Only return results matching given target_campaign_eby_marketplace_id values.
filter_target_campaign_status	[ CampaignStatus ]	Only return results matching given target_campaign_status values.
filter_target_campaign_optimize	[ Boolean ]	Only return results matching given target_campaign_optimize values.
filter_target_campaign_optimization_type	[ OptimizationType ]	Only return results matching given target_campaign_optimization_type values.
filter_target_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given target_campaign_optimization_support values.
filter_target_campaign_amz_targeting_type	[ AmzTargetingType ]	Only return results matching given target_campaign_amz_targeting_type values.
filter_target_campaign_labels	[ String ]	Only return results matching given target_campaign_labels values.
filter_source_adgroup_status	[ AdgroupStatus ]	Only return results matching given source_adgroup_status values.
filter_source_adgroup_labels	[ String ]	Only return results matching given source_adgroup_labels values.
filter_target_adgroup_status	[ AdgroupStatus ]	Only return results matching given target_adgroup_status values.
filter_target_adgroup_labels	[ String ]	Only return results matching given target_adgroup_labels values.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.
filter_action	[ Action ]	Only return results matching given status values.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_source_adgroup_name	[ String ]	Only return results matching given source_adgroup_name values.
filter_source_adspert_adgroup_id	[ CompositeID ]	Only return results matching given source_adspert_adgroup_id values.
filter_source_adspert_campaign_id	[ CompositeID ]	Only return results matching given source_adspert_campaign_id values.
filter_source_campaign_name	[ String ]	Only return results matching given source_campaign_name values.
filter_sync_mode	[ ApiEnumSyncMode ]	Only return results matching given sync_mode values.
filter_target_adgroup_name	[ String ]	Only return results matching given target_adgroup_name values.
filter_target_adspert_adgroup_id	[ CompositeID ]	Only return results matching given target_adspert_adgroup_id values.
filter_target_adspert_campaign_id	[ CompositeID ]	Only return results matching given target_adspert_campaign_id values.
filter_target_campaign_name	[ String ]	Only return results matching given target_campaign_name values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_source_performance_group_name	String	Only return results where source_performance_group_name matches the given string.
search_source_amz_portfolio_name	String	Only return results where source_amz_portfolio_name matches the given string.
search_target_performance_group_name	String	Only return results where target_performance_group_name matches the given string.
search_target_amz_portfolio_name	String	Only return results where target_amz_portfolio_name matches the given string.
search_source_campaign_labels	String	Only return results where source_campaign_labels matches the given string.
search_target_campaign_labels	String	Only return results where target_campaign_labels matches the given string.
search_source_adgroup_labels	String	Only return results where source_adgroup_labels matches the given string.
search_target_adgroup_labels	String	Only return results where target_adgroup_labels matches the given string.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_source_adgroup_id	String	Only return results where source_adgroup_id matches the given string.
search_source_adgroup_name	String	Only return results where source_adgroup_name matches the given string.
search_source_campaign_id	String	Only return results where source_campaign_id matches the given string.
search_source_campaign_name	String	Only return results where source_campaign_name matches the given string.
search_target_adgroup_id	String	Only return results where target_adgroup_id matches the given string.
search_target_adgroup_name	String	Only return results where target_adgroup_name matches the given string.
search_target_campaign_id	String	Only return results where target_campaign_id matches the given string.
search_target_campaign_name	String	Only return results where target_campaign_name matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_source_adgroup_id	SortDirective	Sort results by source_adgroup_id.
sort_source_adgroup_name	SortDirective	Sort results by source_adgroup_name.
sort_source_adspert_adgroup_id	SortDirective	Sort results by source_adspert_adgroup_id.
sort_source_adspert_campaign_id	SortDirective	Sort results by source_adspert_campaign_id.
sort_source_campaign_id	SortDirective	Sort results by source_campaign_id.
sort_source_campaign_name	SortDirective	Sort results by source_campaign_name.
sort_sync_mode	SortDirective	Sort results by sync_mode.
sort_target_adgroup_id	SortDirective	Sort results by target_adgroup_id.
sort_target_adgroup_name	SortDirective	Sort results by target_adgroup_name.
sort_target_adspert_adgroup_id	SortDirective	Sort results by target_adspert_adgroup_id.
sort_target_adspert_campaign_id	SortDirective	Sort results by target_adspert_campaign_id.
sort_target_campaign_id	SortDirective	Sort results by target_campaign_id.
sort_target_campaign_name	SortDirective	Sort results by target_campaign_name.
sort_timestamp	SortDirective	Sort results by timestamp.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
timestamp	DateTime
mutation_summary	Object
⤷ count_created	Integer	Count of created items during product ad sync.
⤷ count_paused	Integer	Count of created items during product ad sync.
⤷ count_archived	Integer	Count of archived items during product ad sync.
⤷ count_failed	Integer	Count of failed items during product ad sync.
⤷ count_enabled	Integer	Count of enabled items during product ad sync.
mutation_details	[ Object ]	NULL if there were only failures during the sync.
⤷ sku	String
⤷ asin	String
⤷ action	Action	Mutate action for the product.
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_id searchable	String	Ad platform specific ID of an advertising account.
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
source_adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
source_adgroup_id searchable	LargeInteger
source_adgroup_name searchable	String
source_adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
source_campaign_id searchable	LargeInteger
source_campaign_name searchable	String
target_adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
target_adgroup_id searchable	LargeInteger
target_adgroup_name searchable	String
target_adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
target_campaign_id searchable	LargeInteger
target_campaign_name searchable	String
sync_mode	ApiEnumSyncMode	Mode of the product ad sync.

Example

http

GET /v3/customers/7027038674/product-ax/log/sync?search_source_adgroup_name=amet+ipsum&search_target_campaign_labels=adlora+elit&filter_source_adspert_portfolio_id=123%3A9999 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/product-ax/log/sync?search_source_adgroup_name=amet+ipsum&search_target_campaign_labels=adlora+elit&filter_source_adspert_portfolio_id=123%3A9999' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/product-ax/log/sync?search_source_adgroup_name=amet+ipsum&search_target_campaign_labels=adlora+elit&filter_source_adspert_portfolio_id=123%3A9999' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/product-ax/log/sync?search_source_adgroup_name=amet+ipsum&search_target_campaign_labels=adlora+elit&filter_source_adspert_portfolio_id=123%3A9999', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "timestamp": "2018-10-21T16:45:23+02:00",
      "mutation_summary": {
        "count_created": 8025587486,
        "count_paused": 6257982864,
        "count_archived": 8992264283,
        "count_failed": 4452795265,
        "count_enabled": 1634771489
      },
      "mutation_details": [
        {
          "sku": "ipsum elit",
          "asin": "sit pariatur",
          "action": "ARCHIVE"
        }
      ],
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "source_adspert_adgroup_id": "123:777",
      "source_adgroup_id": "777",
      "source_adgroup_name": "elit sit",
      "source_adspert_campaign_id": "123:5555",
      "source_campaign_id": "5555",
      "source_campaign_name": "pariatur vehicula",
      "target_adspert_adgroup_id": "123:777",
      "target_adgroup_id": "777",
      "target_adgroup_name": "lorem dolor",
      "target_adspert_campaign_id": "123:5555",
      "target_campaign_id": "5555",
      "target_campaign_name": "ipsum tucan",
      "sync_mode": "ADD-MISSING"
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "timestamp": 1
      }
    }
  }
}

AdGroupCreationLogCollection

GET

GET /v3/customers/(customer_id: int)/product-ax/log/adgroup

Get amz adgroup log for respective customer.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_account_currency	[ String ]	Only return results matching given account_currency values.
filter_source_performance_group_id	[ Integer ]	Only return results matching given source_performance_group_id values.
filter_source_performance_group_name	[ String ]	Only return results matching given source_performance_group_name values.
filter_source_performance_group_enabled	[ Boolean ]	Only return results matching given source_performance_group_enabled values.
filter_source_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given source_performance_group_optimization_type values.
filter_source_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given source_performance_group_goal_types values.
filter_target_performance_group_id	[ Integer ]	Only return results matching given target_performance_group_id values.
filter_target_performance_group_name	[ String ]	Only return results matching given target_performance_group_name values.
filter_target_performance_group_enabled	[ Boolean ]	Only return results matching given target_performance_group_enabled values.
filter_target_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given target_performance_group_optimization_type values.
filter_target_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given target_performance_group_goal_types values.
filter_source_adspert_portfolio_id	[ CompositeID ]	Only return results matching given source_adspert_portfolio_id values.
filter_source_amz_portfolio_id	[ LargeInteger ]	Only return results matching given source_amz_portfolio_id values.
filter_source_amz_portfolio_name	[ String ]	Only return results matching given source_amz_portfolio_name values.
filter_target_adspert_portfolio_id	[ CompositeID ]	Only return results matching given target_adspert_portfolio_id values.
filter_target_amz_portfolio_id	[ LargeInteger ]	Only return results matching given target_amz_portfolio_id values.
filter_target_amz_portfolio_name	[ String ]	Only return results matching given target_amz_portfolio_name values.
filter_source_campaign_type	[ CampaignType ]	Only return results matching given source_campaign_type values.
filter_source_campaign_eby_marketplace_id	[ String ]	Only return results matching given source_campaign_eby_marketplace_id values.
filter_source_campaign_status	[ CampaignStatus ]	Only return results matching given source_campaign_status values.
filter_source_campaign_optimize	[ Boolean ]	Only return results matching given source_campaign_optimize values.
filter_source_campaign_optimization_type	[ OptimizationType ]	Only return results matching given source_campaign_optimization_type values.
filter_source_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given source_campaign_optimization_support values.
filter_source_campaign_amz_targeting_type	[ AmzTargetingType ]	Only return results matching given source_campaign_amz_targeting_type values.
filter_source_campaign_labels	[ String ]	Only return results matching given source_campaign_labels values.
filter_target_campaign_type	[ CampaignType ]	Only return results matching given target_campaign_type values.
filter_target_campaign_eby_marketplace_id	[ String ]	Only return results matching given target_campaign_eby_marketplace_id values.
filter_target_campaign_status	[ CampaignStatus ]	Only return results matching given target_campaign_status values.
filter_target_campaign_optimize	[ Boolean ]	Only return results matching given target_campaign_optimize values.
filter_target_campaign_optimization_type	[ OptimizationType ]	Only return results matching given target_campaign_optimization_type values.
filter_target_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given target_campaign_optimization_support values.
filter_target_campaign_amz_targeting_type	[ AmzTargetingType ]	Only return results matching given target_campaign_amz_targeting_type values.
filter_target_campaign_labels	[ String ]	Only return results matching given target_campaign_labels values.
filter_source_adgroup_status	[ AdgroupStatus ]	Only return results matching given source_adgroup_status values.
filter_source_adgroup_labels	[ String ]	Only return results matching given source_adgroup_labels values.
filter_target_adgroup_status	[ AdgroupStatus ]	Only return results matching given target_adgroup_status values.
filter_target_adgroup_labels	[ String ]	Only return results matching given target_adgroup_labels values.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_source_adgroup_name	[ String ]	Only return results matching given source_adgroup_name values.
filter_source_adspert_adgroup_id	[ CompositeID ]	Only return results matching given source_adspert_adgroup_id values.
filter_source_adspert_campaign_id	[ CompositeID ]	Only return results matching given source_adspert_campaign_id values.
filter_source_campaign_name	[ String ]	Only return results matching given source_campaign_name values.
filter_target_adgroup_name	[ String ]	Only return results matching given target_adgroup_name values.
filter_target_adspert_adgroup_id	[ CompositeID ]	Only return results matching given target_adspert_adgroup_id values.
filter_target_adspert_campaign_id	[ CompositeID ]	Only return results matching given target_adspert_campaign_id values.
filter_target_campaign_name	[ String ]	Only return results matching given target_campaign_name values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_source_performance_group_name	String	Only return results where source_performance_group_name matches the given string.
search_source_amz_portfolio_name	String	Only return results where source_amz_portfolio_name matches the given string.
search_target_performance_group_name	String	Only return results where target_performance_group_name matches the given string.
search_target_amz_portfolio_name	String	Only return results where target_amz_portfolio_name matches the given string.
search_source_campaign_labels	String	Only return results where source_campaign_labels matches the given string.
search_target_campaign_labels	String	Only return results where target_campaign_labels matches the given string.
search_source_adgroup_labels	String	Only return results where source_adgroup_labels matches the given string.
search_target_adgroup_labels	String	Only return results where target_adgroup_labels matches the given string.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_message_details	String	Only return results where message_details matches the given string.
search_message_title	String	Only return results where message_title matches the given string.
search_source_adgroup_id	String	Only return results where source_adgroup_id matches the given string.
search_source_adgroup_name	String	Only return results where source_adgroup_name matches the given string.
search_source_campaign_id	String	Only return results where source_campaign_id matches the given string.
search_source_campaign_name	String	Only return results where source_campaign_name matches the given string.
search_target_adgroup_id	String	Only return results where target_adgroup_id matches the given string.
search_target_adgroup_name	String	Only return results where target_adgroup_name matches the given string.
search_target_campaign_id	String	Only return results where target_campaign_id matches the given string.
search_target_campaign_name	String	Only return results where target_campaign_name matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_source_adgroup_id	SortDirective	Sort results by source_adgroup_id.
sort_source_adgroup_name	SortDirective	Sort results by source_adgroup_name.
sort_source_adspert_adgroup_id	SortDirective	Sort results by source_adspert_adgroup_id.
sort_source_adspert_campaign_id	SortDirective	Sort results by source_adspert_campaign_id.
sort_source_campaign_id	SortDirective	Sort results by source_campaign_id.
sort_source_campaign_name	SortDirective	Sort results by source_campaign_name.
sort_target_adgroup_id	SortDirective	Sort results by target_adgroup_id.
sort_target_adgroup_name	SortDirective	Sort results by target_adgroup_name.
sort_target_adspert_adgroup_id	SortDirective	Sort results by target_adspert_adgroup_id.
sort_target_adspert_campaign_id	SortDirective	Sort results by target_adspert_campaign_id.
sort_target_campaign_id	SortDirective	Sort results by target_campaign_id.
sort_target_campaign_name	SortDirective	Sort results by target_campaign_name.
sort_timestamp	SortDirective	Sort results by timestamp.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
timestamp	DateTime
message_title searchable	String
message_details searchable	String
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_id searchable	String	Ad platform specific ID of an advertising account.
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
source_adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
source_adgroup_id searchable	LargeInteger
source_adgroup_name searchable	String
source_adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
source_campaign_id searchable	LargeInteger
source_campaign_name searchable	String
target_adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
target_adgroup_id searchable	LargeInteger
target_adgroup_name searchable	String
target_adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
target_campaign_id searchable	LargeInteger
target_campaign_name searchable	String

Example

http

GET /v3/customers/7027038674/product-ax/log/adgroup?filter_source_campaign_optimization_support=SUPPORTED&search_target_adgroup_name=dolor+elit&search_source_adgroup_labels=adlora+ipsum HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/product-ax/log/adgroup?filter_source_campaign_optimization_support=SUPPORTED&search_target_adgroup_name=dolor+elit&search_source_adgroup_labels=adlora+ipsum' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/product-ax/log/adgroup?filter_source_campaign_optimization_support=SUPPORTED&search_target_adgroup_name=dolor+elit&search_source_adgroup_labels=adlora+ipsum' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/product-ax/log/adgroup?filter_source_campaign_optimization_support=SUPPORTED&search_target_adgroup_name=dolor+elit&search_source_adgroup_labels=adlora+ipsum', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "timestamp": "2018-10-21T16:45:23+02:00",
      "message_title": "pariatur lorem",
      "message_details": "tucan sit",
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "source_adspert_adgroup_id": "123:777",
      "source_adgroup_id": "777",
      "source_adgroup_name": "elit sit",
      "source_adspert_campaign_id": "123:5555",
      "source_campaign_id": "5555",
      "source_campaign_name": "pariatur vehicula",
      "target_adspert_adgroup_id": "123:777",
      "target_adgroup_id": "777",
      "target_adgroup_name": "lorem dolor",
      "target_adspert_campaign_id": "123:5555",
      "target_campaign_id": "5555",
      "target_campaign_name": "ipsum tucan"
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "timestamp": 1
      }
    }
  }
}

CampaignCreationLogCollection

GET

GET /v3/customers/(customer_id: int)/product-ax/log/campaign

Get amz campaign log for respective customer.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_account_currency	[ String ]	Only return results matching given account_currency values.
filter_source_performance_group_id	[ Integer ]	Only return results matching given source_performance_group_id values.
filter_source_performance_group_name	[ String ]	Only return results matching given source_performance_group_name values.
filter_source_performance_group_enabled	[ Boolean ]	Only return results matching given source_performance_group_enabled values.
filter_source_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given source_performance_group_optimization_type values.
filter_source_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given source_performance_group_goal_types values.
filter_target_performance_group_id	[ Integer ]	Only return results matching given target_performance_group_id values.
filter_target_performance_group_name	[ String ]	Only return results matching given target_performance_group_name values.
filter_target_performance_group_enabled	[ Boolean ]	Only return results matching given target_performance_group_enabled values.
filter_target_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given target_performance_group_optimization_type values.
filter_target_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given target_performance_group_goal_types values.
filter_source_adspert_portfolio_id	[ CompositeID ]	Only return results matching given source_adspert_portfolio_id values.
filter_source_amz_portfolio_id	[ LargeInteger ]	Only return results matching given source_amz_portfolio_id values.
filter_source_amz_portfolio_name	[ String ]	Only return results matching given source_amz_portfolio_name values.
filter_target_adspert_portfolio_id	[ CompositeID ]	Only return results matching given target_adspert_portfolio_id values.
filter_target_amz_portfolio_id	[ LargeInteger ]	Only return results matching given target_amz_portfolio_id values.
filter_target_amz_portfolio_name	[ String ]	Only return results matching given target_amz_portfolio_name values.
filter_source_campaign_type	[ CampaignType ]	Only return results matching given source_campaign_type values.
filter_source_campaign_eby_marketplace_id	[ String ]	Only return results matching given source_campaign_eby_marketplace_id values.
filter_source_campaign_status	[ CampaignStatus ]	Only return results matching given source_campaign_status values.
filter_source_campaign_optimize	[ Boolean ]	Only return results matching given source_campaign_optimize values.
filter_source_campaign_optimization_type	[ OptimizationType ]	Only return results matching given source_campaign_optimization_type values.
filter_source_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given source_campaign_optimization_support values.
filter_source_campaign_amz_targeting_type	[ AmzTargetingType ]	Only return results matching given source_campaign_amz_targeting_type values.
filter_source_campaign_labels	[ String ]	Only return results matching given source_campaign_labels values.
filter_target_campaign_type	[ CampaignType ]	Only return results matching given target_campaign_type values.
filter_target_campaign_eby_marketplace_id	[ String ]	Only return results matching given target_campaign_eby_marketplace_id values.
filter_target_campaign_status	[ CampaignStatus ]	Only return results matching given target_campaign_status values.
filter_target_campaign_optimize	[ Boolean ]	Only return results matching given target_campaign_optimize values.
filter_target_campaign_optimization_type	[ OptimizationType ]	Only return results matching given target_campaign_optimization_type values.
filter_target_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given target_campaign_optimization_support values.
filter_target_campaign_amz_targeting_type	[ AmzTargetingType ]	Only return results matching given target_campaign_amz_targeting_type values.
filter_target_campaign_labels	[ String ]	Only return results matching given target_campaign_labels values.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_source_adspert_campaign_id	[ CompositeID ]	Only return results matching given source_adspert_campaign_id values.
filter_source_campaign_name	[ String ]	Only return results matching given source_campaign_name values.
filter_target_adspert_campaign_id	[ CompositeID ]	Only return results matching given target_adspert_campaign_id values.
filter_target_campaign_name	[ String ]	Only return results matching given target_campaign_name values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_source_performance_group_name	String	Only return results where source_performance_group_name matches the given string.
search_source_amz_portfolio_name	String	Only return results where source_amz_portfolio_name matches the given string.
search_target_performance_group_name	String	Only return results where target_performance_group_name matches the given string.
search_target_amz_portfolio_name	String	Only return results where target_amz_portfolio_name matches the given string.
search_source_campaign_labels	String	Only return results where source_campaign_labels matches the given string.
search_target_campaign_labels	String	Only return results where target_campaign_labels matches the given string.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_message_details	String	Only return results where message_details matches the given string.
search_message_title	String	Only return results where message_title matches the given string.
search_source_campaign_id	String	Only return results where source_campaign_id matches the given string.
search_source_campaign_name	String	Only return results where source_campaign_name matches the given string.
search_target_campaign_id	String	Only return results where target_campaign_id matches the given string.
search_target_campaign_name	String	Only return results where target_campaign_name matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_source_adspert_campaign_id	SortDirective	Sort results by source_adspert_campaign_id.
sort_source_campaign_id	SortDirective	Sort results by source_campaign_id.
sort_source_campaign_name	SortDirective	Sort results by source_campaign_name.
sort_target_adspert_campaign_id	SortDirective	Sort results by target_adspert_campaign_id.
sort_target_campaign_id	SortDirective	Sort results by target_campaign_id.
sort_target_campaign_name	SortDirective	Sort results by target_campaign_name.
sort_timestamp	SortDirective	Sort results by timestamp.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
timestamp	DateTime
message_title searchable	String
message_details searchable	String
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_id searchable	String	Ad platform specific ID of an advertising account.
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
source_adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
source_campaign_id searchable	LargeInteger
source_campaign_name searchable	String
target_adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
target_campaign_id searchable	LargeInteger
target_campaign_name searchable	String

Example

http

GET /v3/customers/7027038674/product-ax/log/campaign?sort_source_adspert_campaign_id=-6&filter_source_campaign_type=AMAZON-SPONSORED-BRANDS&filter_source_performance_group_id=1245 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/product-ax/log/campaign?sort_source_adspert_campaign_id=-6&filter_source_campaign_type=AMAZON-SPONSORED-BRANDS&filter_source_performance_group_id=1245' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/product-ax/log/campaign?sort_source_adspert_campaign_id=-6&filter_source_campaign_type=AMAZON-SPONSORED-BRANDS&filter_source_performance_group_id=1245' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/product-ax/log/campaign?sort_source_adspert_campaign_id=-6&filter_source_campaign_type=AMAZON-SPONSORED-BRANDS&filter_source_performance_group_id=1245', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "timestamp": "2018-10-21T16:45:23+02:00",
      "message_title": "pariatur lorem",
      "message_details": "tucan sit",
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "source_adspert_campaign_id": "123:5555",
      "source_campaign_id": "5555",
      "source_campaign_name": "pariatur vehicula",
      "target_adspert_campaign_id": "123:5555",
      "target_campaign_id": "5555",
      "target_campaign_name": "ipsum tucan"
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "timestamp": 1
      }
    }
  }
}

ProductAdSyncTargetsLogCollection

GET

GET /v3/customers/(customer_id: int)/product-ax/log/sync-targets

Get product ad sync targets logs for respective customer.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_account_currency	[ String ]	Only return results matching given account_currency values.
filter_source_performance_group_id	[ Integer ]	Only return results matching given source_performance_group_id values.
filter_source_performance_group_name	[ String ]	Only return results matching given source_performance_group_name values.
filter_source_performance_group_enabled	[ Boolean ]	Only return results matching given source_performance_group_enabled values.
filter_source_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given source_performance_group_optimization_type values.
filter_source_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given source_performance_group_goal_types values.
filter_target_performance_group_id	[ Integer ]	Only return results matching given target_performance_group_id values.
filter_target_performance_group_name	[ String ]	Only return results matching given target_performance_group_name values.
filter_target_performance_group_enabled	[ Boolean ]	Only return results matching given target_performance_group_enabled values.
filter_target_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given target_performance_group_optimization_type values.
filter_target_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given target_performance_group_goal_types values.
filter_source_adspert_portfolio_id	[ CompositeID ]	Only return results matching given source_adspert_portfolio_id values.
filter_source_amz_portfolio_id	[ LargeInteger ]	Only return results matching given source_amz_portfolio_id values.
filter_source_amz_portfolio_name	[ String ]	Only return results matching given source_amz_portfolio_name values.
filter_target_adspert_portfolio_id	[ CompositeID ]	Only return results matching given target_adspert_portfolio_id values.
filter_target_amz_portfolio_id	[ LargeInteger ]	Only return results matching given target_amz_portfolio_id values.
filter_target_amz_portfolio_name	[ String ]	Only return results matching given target_amz_portfolio_name values.
filter_source_campaign_type	[ CampaignType ]	Only return results matching given source_campaign_type values.
filter_source_campaign_eby_marketplace_id	[ String ]	Only return results matching given source_campaign_eby_marketplace_id values.
filter_source_campaign_status	[ CampaignStatus ]	Only return results matching given source_campaign_status values.
filter_source_campaign_optimize	[ Boolean ]	Only return results matching given source_campaign_optimize values.
filter_source_campaign_optimization_type	[ OptimizationType ]	Only return results matching given source_campaign_optimization_type values.
filter_source_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given source_campaign_optimization_support values.
filter_source_campaign_amz_targeting_type	[ AmzTargetingType ]	Only return results matching given source_campaign_amz_targeting_type values.
filter_source_campaign_labels	[ String ]	Only return results matching given source_campaign_labels values.
filter_target_campaign_type	[ CampaignType ]	Only return results matching given target_campaign_type values.
filter_target_campaign_eby_marketplace_id	[ String ]	Only return results matching given target_campaign_eby_marketplace_id values.
filter_target_campaign_status	[ CampaignStatus ]	Only return results matching given target_campaign_status values.
filter_target_campaign_optimize	[ Boolean ]	Only return results matching given target_campaign_optimize values.
filter_target_campaign_optimization_type	[ OptimizationType ]	Only return results matching given target_campaign_optimization_type values.
filter_target_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given target_campaign_optimization_support values.
filter_target_campaign_amz_targeting_type	[ AmzTargetingType ]	Only return results matching given target_campaign_amz_targeting_type values.
filter_target_campaign_labels	[ String ]	Only return results matching given target_campaign_labels values.
filter_source_adgroup_status	[ AdgroupStatus ]	Only return results matching given source_adgroup_status values.
filter_source_adgroup_labels	[ String ]	Only return results matching given source_adgroup_labels values.
filter_target_adgroup_status	[ AdgroupStatus ]	Only return results matching given target_adgroup_status values.
filter_target_adgroup_labels	[ String ]	Only return results matching given target_adgroup_labels values.
filter_reasons	[ Reason ]	Only return results matching given reasons values.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_action	[ Action ]	Only return results matching given action values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_source_adgroup_name	[ String ]	Only return results matching given source_adgroup_name values.
filter_source_adspert_adgroup_id	[ CompositeID ]	Only return results matching given source_adspert_adgroup_id values.
filter_source_adspert_campaign_id	[ CompositeID ]	Only return results matching given source_adspert_campaign_id values.
filter_source_campaign_name	[ String ]	Only return results matching given source_campaign_name values.
filter_target_adgroup_name	[ String ]	Only return results matching given target_adgroup_name values.
filter_target_adspert_adgroup_id	[ CompositeID ]	Only return results matching given target_adspert_adgroup_id values.
filter_target_adspert_campaign_id	[ CompositeID ]	Only return results matching given target_adspert_campaign_id values.
filter_target_campaign_name	[ String ]	Only return results matching given target_campaign_name values.
filter_user_id	[ Integer ]	Only return results matching given user_id values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_source_performance_group_name	String	Only return results where source_performance_group_name matches the given string.
search_source_amz_portfolio_name	String	Only return results where source_amz_portfolio_name matches the given string.
search_target_performance_group_name	String	Only return results where target_performance_group_name matches the given string.
search_target_amz_portfolio_name	String	Only return results where target_amz_portfolio_name matches the given string.
search_source_campaign_labels	String	Only return results where source_campaign_labels matches the given string.
search_target_campaign_labels	String	Only return results where target_campaign_labels matches the given string.
search_source_adgroup_labels	String	Only return results where source_adgroup_labels matches the given string.
search_target_adgroup_labels	String	Only return results where target_adgroup_labels matches the given string.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_message_details	String	Only return results where message_details matches the given string.
search_message_title	String	Only return results where message_title matches the given string.
search_source_adgroup_id	String	Only return results where source_adgroup_id matches the given string.
search_source_adgroup_name	String	Only return results where source_adgroup_name matches the given string.
search_source_campaign_id	String	Only return results where source_campaign_id matches the given string.
search_source_campaign_name	String	Only return results where source_campaign_name matches the given string.
search_target_adgroup_id	String	Only return results where target_adgroup_id matches the given string.
search_target_adgroup_name	String	Only return results where target_adgroup_name matches the given string.
search_target_campaign_id	String	Only return results where target_campaign_id matches the given string.
search_target_campaign_name	String	Only return results where target_campaign_name matches the given string.
search_user_email	String	Only return results where user_email matches the given string.
search_user_name	String	Only return results where user_name matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_source_adgroup_id	SortDirective	Sort results by source_adgroup_id.
sort_source_adgroup_name	SortDirective	Sort results by source_adgroup_name.
sort_source_adspert_adgroup_id	SortDirective	Sort results by source_adspert_adgroup_id.
sort_source_adspert_campaign_id	SortDirective	Sort results by source_adspert_campaign_id.
sort_source_campaign_id	SortDirective	Sort results by source_campaign_id.
sort_source_campaign_name	SortDirective	Sort results by source_campaign_name.
sort_target_adgroup_id	SortDirective	Sort results by target_adgroup_id.
sort_target_adgroup_name	SortDirective	Sort results by target_adgroup_name.
sort_target_adspert_adgroup_id	SortDirective	Sort results by target_adspert_adgroup_id.
sort_target_adspert_campaign_id	SortDirective	Sort results by target_adspert_campaign_id.
sort_target_campaign_id	SortDirective	Sort results by target_campaign_id.
sort_target_campaign_name	SortDirective	Sort results by target_campaign_name.
sort_timestamp	SortDirective	Sort results by timestamp.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
timestamp	DateTime
action	Action
user_id	Integer	-1 if change was made by Adspert.
user_email searchable	String	NULL if change was made by Adspert.
user_name searchable	String	Adspert if change was made by Adspert.
message_title searchable	String
message_details searchable	String
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_id searchable	String	Ad platform specific ID of an advertising account.
account_name searchable	String
account_platform	AdPlatform	The account’s advertising platform.
source_adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
source_campaign_id searchable	LargeInteger
source_campaign_name searchable	String
source_adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
source_adgroup_id searchable	LargeInteger
source_adgroup_name searchable	String
target_adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
target_campaign_id searchable	LargeInteger
target_campaign_name searchable	String
target_adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
target_adgroup_id searchable	LargeInteger
target_adgroup_name searchable	String

Example

http

GET /v3/customers/7027038674/product-ax/log/sync-targets?search_source_adgroup_id=adlora+tucan&search_source_campaign_name=dolor+pariatur&filter_target_performance_group_goal_types=CLICKS-PER-DAY HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/product-ax/log/sync-targets?search_source_adgroup_id=adlora+tucan&search_source_campaign_name=dolor+pariatur&filter_target_performance_group_goal_types=CLICKS-PER-DAY' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/product-ax/log/sync-targets?search_source_adgroup_id=adlora+tucan&search_source_campaign_name=dolor+pariatur&filter_target_performance_group_goal_types=CLICKS-PER-DAY' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/product-ax/log/sync-targets?search_source_adgroup_id=adlora+tucan&search_source_campaign_name=dolor+pariatur&filter_target_performance_group_goal_types=CLICKS-PER-DAY', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "timestamp": "2018-10-21T16:45:23+02:00",
      "action": "CREATE",
      "user_id": 4034300999,
      "user_email": "amet tucan",
      "user_name": "adlora ipsum",
      "message_title": "pariatur lorem",
      "message_details": "tucan sit",
      "adspert_account_id": 123,
      "account_id": "amet lorem",
      "account_name": "vehicula ipsum",
      "account_platform": "AMAZON",
      "source_adspert_campaign_id": "123:5555",
      "source_campaign_id": "5555",
      "source_campaign_name": "pariatur vehicula",
      "source_adspert_adgroup_id": "123:777",
      "source_adgroup_id": "777",
      "source_adgroup_name": "elit sit",
      "target_adspert_campaign_id": "123:5555",
      "target_campaign_id": "5555",
      "target_campaign_name": "ipsum tucan",
      "target_adspert_adgroup_id": "123:777",
      "target_adgroup_id": "777",
      "target_adgroup_name": "lorem dolor"
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "timestamp": 1
      }
    }
  }
}

FilterUserCollectionProductAdsSyncTargets

GET

GET /v3/customers/(customer_id: int)/product-ax/log/sync-targets/users

Get users that can be used as filters in the log endpoint.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.

Response Data (object list, json or csv or xlsx)

Name	Type	Description
user_id	Integer	Adspert user is assigned -1
user_name	String
user_email	String

Example

http

GET /v3/customers/7027038674/product-ax/log/sync-targets/users?include=ipsum.amet&filter_date_le=2018-10-21&exclude=elit.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/product-ax/log/sync-targets/users?include=ipsum.amet&filter_date_le=2018-10-21&exclude=elit.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/product-ax/log/sync-targets/users?include=ipsum.amet&filter_date_le=2018-10-21&exclude=elit.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/product-ax/log/sync-targets/users?include=ipsum.amet&filter_date_le=2018-10-21&exclude=elit.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "user_id": 4034300999,
      "user_name": "adlora ipsum",
      "user_email": "amet tucan"
    }
  ],
  "meta": {}
}

ProposalsLogCollection

GET

GET /v3/customers/(customer_id: int)/criterion-addition/log/proposals

Get Proposal Logs for respective customer.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.
filter_account_id	[ String ]	Only return results matching given source.account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given source.account_is_demo values.
filter_account_name	[ String ]	Only return results matching given source.account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given source.account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given source.account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given source.account_tags_user values.
filter_adspert_account_id	[ Integer ]	Only return results matching given source.adspert_account_id values.
filter_criterion_name	[ String ]	Only return results matching given criterion_name values.
filter_criterion_subtype	[ CriterionAdditionCriterionSubtype ]	Only return results matching given criterion_subtype values.
filter_criterion_type	[ CriterionAdditionCriterionType ]	Only return results matching given criterion_type values.
filter_destination_adgroup_labels	[ String ]	Only return results matching given destinations.effective_destination.adgroup_labels values.
filter_destination_adgroup_name	[ String ]	Only return results matching given destinations.effective_destination.adgroup_name values.
filter_destination_adgroup_status	[ AdgroupStatus ]	Only return results matching given destinations.effective_destination.adgroup_status values.
filter_destination_adspert_adgroup_id	[ CompositeID ]	Only return results matching given destinations.effective_destination.adspert_adgroup_id values.
filter_destination_adspert_campaign_id	[ CompositeID ]	Only return results matching given destinations.effective_destination.adspert_campaign_id values.
filter_destination_adspert_portfolio_id	[ CompositeID ]	Only return results matching given destinations.effective_destination.adspert_portfolio_id values.
filter_destination_amz_portfolio_name	[ String ]	Only return results matching given destinations.effective_destination.amz_portfolio_name values.
filter_destination_campaign_eby_marketplace_id	[ String ]	Only return results matching given destinations.effective_destination.campaign_eby_marketplace_id values.
filter_destination_campaign_labels	[ String ]	Only return results matching given destinations.effective_destination.campaign_labels values.
filter_destination_campaign_name	[ String ]	Only return results matching given destinations.effective_destination.campaign_name values.
filter_destination_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given destinations.effective_destination.campaign_optimization_support values.
filter_destination_campaign_optimization_type	[ OptimizationType ]	Only return results matching given destinations.effective_destination.campaign_optimization_type values.
filter_destination_campaign_optimize	[ Boolean ]	Only return results matching given destinations.effective_destination.campaign_optimize values.
filter_destination_campaign_status	[ CampaignStatus ]	Only return results matching given destinations.effective_destination.campaign_status values.
filter_destination_campaign_type	[ CampaignType ]	Only return results matching given destinations.effective_destination.campaign_type values.
filter_destination_id	[ LargeInteger ]	Only return results matching given destinations.destination_id values.
filter_destination_match_type	[ CriterionAdditionMatchType ]	Only return results matching given destinations.match_type values.
filter_destination_negative	[ Boolean ]	Only return results matching given destinations.negative values.
filter_destination_performance_group_enabled	[ Boolean ]	Only return results matching given destinations.effective_destination.performance_group_enabled values.
filter_destination_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given destinations.effective_destination.performance_group_goal_types values.
filter_destination_performance_group_id	[ Integer ]	Only return results matching given destinations.effective_destination.performance_group_id values.
filter_destination_performance_group_name	[ String ]	Only return results matching given destinations.effective_destination.performance_group_name values.
filter_destination_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given destinations.effective_destination.performance_group_optimization_type values.
filter_destination_state	[ CriterionAdditionDestinationLogState ]	Only return results matching given destinations.state values.
filter_destination_type	[ CriterionAdditionDestinationType ]	Only return results matching given destinations.destination_type values.
filter_proposal_id	[ LargeInteger ]	Only return results matching given proposal_id values.
filter_proposal_reasons	[ CriterionAdditionProposalReason ]	Only return results matching given proposal_reasons values.
filter_proposal_state	[ CriterionAdditionProposalState ]	Only return results matching given proposal_state values.
filter_proposal_type	[ CriterionAdditionProposalType ]	Only return results matching given proposal_type values.
filter_rule_type_id	[ Integer ]	Only return results matching given rule_type_id values.
filter_source_adgroup_labels	[ String ]	Only return results matching given source.adgroup_labels values.
filter_source_adgroup_name	[ String ]	Only return results matching given source.adgroup_name values.
filter_source_adgroup_status	[ AdgroupStatus ]	Only return results matching given source.adgroup_status values.
filter_source_adspert_adgroup_id	[ CompositeID ]	Only return results matching given source.adspert_adgroup_id values.
filter_source_adspert_campaign_id	[ CompositeID ]	Only return results matching given source.adspert_campaign_id values.
filter_source_adspert_portfolio_id	[ CompositeID ]	Only return results matching given source.adspert_portfolio_id values.
filter_source_amz_portfolio_name	[ String ]	Only return results matching given source.amz_portfolio_name values.
filter_source_campaign_eby_marketplace_id	[ String ]	Only return results matching given source.campaign_eby_marketplace_id values.
filter_source_campaign_labels	[ String ]	Only return results matching given source.campaign_labels values.
filter_source_campaign_name	[ String ]	Only return results matching given source.campaign_name values.
filter_source_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given source.campaign_optimization_support values.
filter_source_campaign_optimization_type	[ OptimizationType ]	Only return results matching given source.campaign_optimization_type values.
filter_source_campaign_optimize	[ Boolean ]	Only return results matching given source.campaign_optimize values.
filter_source_campaign_status	[ CampaignStatus ]	Only return results matching given source.campaign_status values.
filter_source_campaign_type	[ CampaignType ]	Only return results matching given source.campaign_type values.
filter_source_performance_group_enabled	[ Boolean ]	Only return results matching given source.performance_group_enabled values.
filter_source_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given source.performance_group_goal_types values.
filter_source_performance_group_id	[ Integer ]	Only return results matching given source.performance_group_id values.
filter_source_performance_group_name	[ String ]	Only return results matching given source.performance_group_name values.
filter_source_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given source.performance_group_optimization_type values.
filter_user_id	[ Integer ]	Only return results matching given user_id values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where source.account_id matches the given string.
search_account_name	String	Only return results where source.account_name matches the given string.
search_account_tags_user	String	Only return results where source.account_tags_user matches the given string.
search_adspert_account_id	String	Only return results where source.adspert_account_id matches the given string.
search_criterion_name	String	Only return results where criterion_name matches the given string.
search_destination_adgroup_id	String	Only return results where destinations.effective_destination.adgroup_id matches the given string.
search_destination_adgroup_labels	String	Only return results where destinations.effective_destination.adgroup_labels matches the given string.
search_destination_adgroup_name	String	Only return results where destinations.effective_destination.adgroup_name matches the given string.
search_destination_amz_portfolio_id	String	Only return results where destinations.effective_destination.amz_portfolio_id matches the given string.
search_destination_amz_portfolio_name	String	Only return results where destinations.effective_destination.amz_portfolio_name matches the given string.
search_destination_campaign_id	String	Only return results where destinations.effective_destination.campaign_id matches the given string.
search_destination_campaign_labels	String	Only return results where destinations.effective_destination.campaign_labels matches the given string.
search_destination_campaign_name	String	Only return results where destinations.effective_destination.campaign_name matches the given string.
search_destination_performance_group_id	String	Only return results where destinations.effective_destination.performance_group_id matches the given string.
search_destination_performance_group_name	String	Only return results where destinations.effective_destination.performance_group_name matches the given string.
search_source_adgroup_id	String	Only return results where source.adgroup_id matches the given string.
search_source_adgroup_labels	String	Only return results where source.adgroup_labels matches the given string.
search_source_adgroup_name	String	Only return results where source.adgroup_name matches the given string.
search_source_amz_portfolio_id	String	Only return results where source.amz_portfolio_id matches the given string.
search_source_amz_portfolio_name	String	Only return results where source.amz_portfolio_name matches the given string.
search_source_campaign_id	String	Only return results where source.campaign_id matches the given string.
search_source_campaign_labels	String	Only return results where source.campaign_labels matches the given string.
search_source_campaign_name	String	Only return results where source.campaign_name matches the given string.
search_source_performance_group_id	String	Only return results where source.performance_group_id matches the given string.
search_source_performance_group_name	String	Only return results where source.performance_group_name matches the given string.
search_user_email	String	Only return results where user_email matches the given string.
search_user_name	String	Only return results where user_name matches the given string.
sort_account_id	SortDirective	Sort results by source.account_id.
sort_account_is_demo	SortDirective	Sort results by source.account_is_demo.
sort_account_name	SortDirective	Sort results by source.account_name.
sort_account_optimize	SortDirective	Sort results by source.account_optimize.
sort_account_platform	SortDirective	Sort results by source.account_platform.
sort_adspert_account_id	SortDirective	Sort results by source.adspert_account_id.
sort_criterion_name	SortDirective	Sort results by criterion_name.
sort_criterion_subtype	SortDirective	Sort results by criterion_subtype.
sort_criterion_type	SortDirective	Sort results by criterion_type.
sort_proposal_id	SortDirective	Sort results by proposal_id.
sort_proposal_state	SortDirective	Sort results by proposal_state.
sort_proposal_type	SortDirective	Sort results by proposal_type.
sort_rule_type_id	SortDirective	Sort results by rule_type_id.
sort_source_adgroup_id	SortDirective	Sort results by source.adgroup_id.
sort_source_adgroup_name	SortDirective	Sort results by source.adgroup_name.
sort_source_adgroup_status	SortDirective	Sort results by source.adgroup_status.
sort_source_adspert_adgroup_id	SortDirective	Sort results by source.adspert_adgroup_id.
sort_source_adspert_campaign_id	SortDirective	Sort results by source.adspert_campaign_id.
sort_source_adspert_portfolio_id	SortDirective	Sort results by source.adspert_portfolio_id.
sort_source_amz_portfolio_id	SortDirective	Sort results by source.amz_portfolio_id.
sort_source_amz_portfolio_name	SortDirective	Sort results by source.amz_portfolio_name.
sort_source_campaign_eby_marketplace_id	SortDirective	Sort results by source.campaign_eby_marketplace_id.
sort_source_campaign_id	SortDirective	Sort results by source.campaign_id.
sort_source_campaign_name	SortDirective	Sort results by source.campaign_name.
sort_source_campaign_optimization_support	SortDirective	Sort results by source.campaign_optimization_support.
sort_source_campaign_optimization_type	SortDirective	Sort results by source.campaign_optimization_type.
sort_source_campaign_optimize	SortDirective	Sort results by source.campaign_optimize.
sort_source_campaign_status	SortDirective	Sort results by source.campaign_status.
sort_source_campaign_type	SortDirective	Sort results by source.campaign_type.
sort_source_performance_group_enabled	SortDirective	Sort results by source.performance_group_enabled.
sort_source_performance_group_goal_types	SortDirective	Sort results by source.performance_group_goal_types.
sort_source_performance_group_id	SortDirective	Sort results by source.performance_group_id.
sort_source_performance_group_name	SortDirective	Sort results by source.performance_group_name.
sort_source_performance_group_optimization_type	SortDirective	Sort results by source.performance_group_optimization_type.
sort_timestamp	SortDirective	Sort results by timestamp.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
timestamp	DateTime
user_id	Integer	-1 if proposal was made by Adspert.
user_email searchable	String	NULL if proposal was made by Adspert.
user_name searchable	String	Adspert user if proposal was made by Adspert.
proposal_id	LargeInteger	Unique ID of the proposal.
proposal_type	CriterionAdditionProposalType	Type of the proposal.
proposal_reasons	[ CriterionAdditionProposalReason ]	A list of reasons why the proposal was generated.
proposal_state	CriterionAdditionProposalState	State of the proposal.
rule_type_id	Integer	Id of the matched Rule Type.
criterion_name searchable	String	Name of criterion proposed to be created.
criterion_type	CriterionAdditionCriterionType	Type of criterion proposed to be created.
criterion_subtype	CriterionAdditionCriterionSubtype	Subtype of criterion proposed to be created.
destinations	[ Object ]
⤷ destination_id	LargeInteger
⤷ state	CriterionAdditionDestinationLogState
⤷ rule_snapshot_id	LargeInteger	Id of the snapshot of the rule that defined current destination. NULL if destination had been created by the user.
⤷ destination_type	CriterionAdditionDestinationType
⤷ match_type	CriterionAdditionMatchType	Keyword match type. This field is populated only for destinations that belong to proposals where criterion_type is KEYWORD.
⤷ negative	Boolean	Is the criterion created for this destination supposed to be negative?
⤷ rejection_reason	String
⤷ failure_reason	String
⤷ criterion_id	LargeInteger	Criterion id that was created for this destination. NULL when state is not added.
⤷ effective_destination	Object	Details about the effective destination adgroup.
⤷ performance_group_id searchable	Integer	Unique ID of the performance group
⤷ performance_group_name searchable	String	Unique name of the performance group.
⤷ performance_group_enabled	Boolean
⤷ performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
⤷ performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
⤷ adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
⤷ amz_portfolio_id searchable	LargeInteger
⤷ amz_portfolio_name searchable	String
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id searchable	LargeInteger
⤷ campaign_name searchable	String
⤷ campaign_type	CampaignType
⤷ campaign_eby_marketplace_id	String
⤷ campaign_status	CampaignStatus
⤷ campaign_optimize	Boolean
⤷ campaign_optimization_type	OptimizationType
⤷ campaign_optimization_support	CampaignOptimizationSupport
⤷ campaign_labels searchable	[ String ]
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_id searchable	LargeInteger
⤷ adgroup_name searchable	String
⤷ adgroup_status	AdgroupStatus
⤷ adgroup_labels searchable	[ String ]
source	Object
⤷ adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
⤷ account_id searchable	String	Ad platform specific ID of an advertising account.
⤷ account_name searchable	String
⤷ account_platform	AdPlatform	The account’s advertising platform.
⤷ account_optimize	Boolean	If optimization by Adspert is enabled for this account.
⤷ account_tags_user searchable	[ String ]
⤷ account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
⤷ performance_group_id searchable	Integer	Unique ID of the performance group
⤷ performance_group_name searchable	String	Unique name of the performance group.
⤷ performance_group_enabled	Boolean
⤷ performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
⤷ performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
⤷ adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
⤷ amz_portfolio_id searchable	LargeInteger
⤷ amz_portfolio_name searchable	String
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id searchable	LargeInteger
⤷ campaign_name searchable	String
⤷ campaign_type	CampaignType
⤷ campaign_eby_marketplace_id	String
⤷ campaign_status	CampaignStatus
⤷ campaign_optimize	Boolean
⤷ campaign_optimization_type	OptimizationType
⤷ campaign_optimization_support	CampaignOptimizationSupport
⤷ campaign_labels searchable	[ String ]
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_id searchable	LargeInteger
⤷ adgroup_name searchable	String
⤷ adgroup_status	AdgroupStatus
⤷ adgroup_labels searchable	[ String ]
rule_snapshots	[ Object ]
⤷ rule_snapshot_id	LargeInteger	Id of the rule snapshot.
⤷ rule_id	LargeInteger	Id of the rule that this snapshot was created for.
⤷ action	CriterionAdditionRuleAction	Rule action at the time that the snapshot was generated.
⤷ filters	[ Object ]	Rule filters at the time that the snapshot was generated.
⤷ operand	CriterionAdditionRuleFilterOperand	Rule filter operand.
⤷ operation	CriterionAdditionRuleFilterOperation	Rule filter operation.
⤷ values	[ Any ]	Rule filter values.
⤷ catch_all	Boolean	Rule catch_all value at the time that the snapshot was generated.
⤷ defined_at	Object	Extra information about the location where snapshotted rule was defined at.
⤷ level	CriterionAdditionRuleLevel
⤷ platform	AdPlatform
⤷ adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
⤷ account_id searchable	String	Ad platform specific ID of an advertising account.
⤷ account_name searchable	String
⤷ account_platform	AdPlatform	The account’s advertising platform.
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id searchable	LargeInteger
⤷ campaign_name searchable	String
⤷ campaign_type	CampaignType
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_id searchable	LargeInteger
⤷ adgroup_name searchable	String

Example

http

GET /v3/customers/7027038674/criterion-addition/log/proposals?filter_destination_adspert_adgroup_id=123%3A13&sort_source_adspert_adgroup_id=7&search_destination_amz_portfolio_id=pariatur+lorem HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/proposals?filter_destination_adspert_adgroup_id=123%3A13&sort_source_adspert_adgroup_id=7&search_destination_amz_portfolio_id=pariatur+lorem' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/proposals?filter_destination_adspert_adgroup_id=123%3A13&sort_source_adspert_adgroup_id=7&search_destination_amz_portfolio_id=pariatur+lorem' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/proposals?filter_destination_adspert_adgroup_id=123%3A13&sort_source_adspert_adgroup_id=7&search_destination_amz_portfolio_id=pariatur+lorem', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "timestamp": "2018-10-21T16:45:23+02:00",
      "user_id": 4034300999,
      "user_email": "amet tucan",
      "user_name": "adlora ipsum",
      "proposal_id": "55669895173420790989137281",
      "proposal_type": "ADDITION",
      "proposal_reasons": [
        "CHEAP-CLICK"
      ],
      "proposal_state": "ACCEPTED",
      "rule_type_id": 5675219470,
      "criterion_name": "dolor adlora",
      "criterion_type": "KEYWORD",
      "criterion_subtype": "ASIN",
      "destinations": [
        {
          "destination_id": "78046413193991906103940983",
          "state": "ADDED",
          "rule_snapshot_id": "29900904027622664405022614",
          "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
          "match_type": "BROAD",
          "negative": true,
          "rejection_reason": "lorem pariatur",
          "failure_reason": "sit ipsum",
          "criterion_id": "28829550734074914927304228",
          "effective_destination": {
            "performance_group_id": "1245",
            "performance_group_name": "dolor sit",
            "performance_group_enabled": true,
            "performance_group_optimization_type": "CLICK",
            "performance_group_goals": [
              {
                "goal_type": "CLICKS-PER-DAY",
                "goal_value": 1.41,
                "goal_currency": "AED",
                "goal_micros": 6300000,
                "goal_ratio": 8.77
              }
            ],
            "performance_group_goal_types": [
              "CLICKS-PER-DAY"
            ],
            "adspert_portfolio_id": "123:9999",
            "amz_portfolio_id": "9999",
            "amz_portfolio_name": "elit adlora",
            "adspert_campaign_id": "123:5555",
            "campaign_id": "5555",
            "campaign_name": "sit ipsum",
            "campaign_type": "AMAZON-SPONSORED-BRANDS",
            "campaign_eby_marketplace_id": "amet pariatur",
            "campaign_status": "ACTIVE",
            "campaign_optimize": true,
            "campaign_optimization_type": "CLICK",
            "campaign_optimization_support": "SUPPORTED",
            "campaign_labels": [
              "ipsum dolor"
            ],
            "adspert_adgroup_id": "123:777",
            "adgroup_id": "777",
            "adgroup_name": "tucan lorem",
            "adgroup_status": "ACTIVE",
            "adgroup_labels": [
              "elit ipsum"
            ]
          }
        }
      ],
      "source": {
        "adspert_account_id": 123,
        "account_id": "amet lorem",
        "account_name": "vehicula ipsum",
        "account_platform": "AMAZON",
        "account_optimize": true,
        "account_tags_user": [
          "vehicula amet"
        ],
        "account_is_demo": true,
        "performance_group_id": "1245",
        "performance_group_name": "dolor sit",
        "performance_group_enabled": true,
        "performance_group_optimization_type": "CLICK",
        "performance_group_goals": [
          {
            "goal_type": "CLICKS-PER-DAY",
            "goal_value": 1.41,
            "goal_currency": "AED",
            "goal_micros": 6300000,
            "goal_ratio": 8.77
          }
        ],
        "performance_group_goal_types": [
          "CLICKS-PER-DAY"
        ],
        "adspert_portfolio_id": "123:9999",
        "amz_portfolio_id": "9999",
        "amz_portfolio_name": "elit adlora",
        "adspert_campaign_id": "123:5555",
        "campaign_id": "5555",
        "campaign_name": "sit ipsum",
        "campaign_type": "AMAZON-SPONSORED-BRANDS",
        "campaign_eby_marketplace_id": "amet pariatur",
        "campaign_status": "ACTIVE",
        "campaign_optimize": true,
        "campaign_optimization_type": "CLICK",
        "campaign_optimization_support": "SUPPORTED",
        "campaign_labels": [
          "ipsum dolor"
        ],
        "adspert_adgroup_id": "123:777",
        "adgroup_id": "777",
        "adgroup_name": "tucan lorem",
        "adgroup_status": "ACTIVE",
        "adgroup_labels": [
          "elit ipsum"
        ]
      },
      "rule_snapshots": [
        {
          "rule_snapshot_id": "29900904027622664405022614",
          "rule_id": "49754540226638646583189955",
          "action": "ADD",
          "filters": [
            {
              "operand": "DOMAIN",
              "operation": "CONTAINS",
              "values": [
                1
              ]
            }
          ],
          "catch_all": true,
          "defined_at": {
            "level": "ACCOUNT",
            "platform": "AMAZON",
            "adspert_account_id": 123,
            "account_id": "amet lorem",
            "account_name": "vehicula ipsum",
            "account_platform": "AMAZON",
            "adspert_campaign_id": "123:5555",
            "campaign_id": "5555",
            "campaign_name": "sit ipsum",
            "campaign_type": "AMAZON-SPONSORED-BRANDS",
            "adspert_adgroup_id": "123:777",
            "adgroup_id": "777",
            "adgroup_name": "tucan lorem"
          }
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "timestamp": 1
      }
    }
  }
}

FilterUserCollectionCriterionAdditionProposals

GET

GET /v3/customers/(customer_id: int)/criterion-addition/log/proposals/users

Get users that can be used as filters in the log endpoint.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.

Response Data (object list, json or csv or xlsx)

Name	Type	Description
user_id	Integer	Adspert user is assigned -1
user_name	String
user_email	String

Example

http

GET /v3/customers/7027038674/criterion-addition/log/proposals/users?filter_date_le=2018-10-21&exclude=elit.amet&include=ipsum.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/proposals/users?filter_date_le=2018-10-21&exclude=elit.amet&include=ipsum.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/proposals/users?filter_date_le=2018-10-21&exclude=elit.amet&include=ipsum.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/proposals/users?filter_date_le=2018-10-21&exclude=elit.amet&include=ipsum.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "user_id": 4034300999,
      "user_name": "adlora ipsum",
      "user_email": "amet tucan"
    }
  ],
  "meta": {}
}

ProposalDestinationStateCollection

GET

GET /v3/customers/(customer_id: int)/criterion-addition/log/proposals/state

Get Proposal Destination States for respective customer.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.

Response Data (object list, json or csv or xlsx)

Name	Type	Description
destination_state	CriterionAdditionDestinationLogState

Example

http

GET /v3/customers/7027038674/criterion-addition/log/proposals/state?filter_date_ge=2018-10-21&exclude=elit.amet&include=ipsum.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/proposals/state?filter_date_ge=2018-10-21&exclude=elit.amet&include=ipsum.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/proposals/state?filter_date_ge=2018-10-21&exclude=elit.amet&include=ipsum.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/proposals/state?filter_date_ge=2018-10-21&exclude=elit.amet&include=ipsum.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "destination_state": "ADDED"
    }
  ],
  "meta": {}
}

RulesLogCollection

GET

GET /v3/customers/(customer_id: int)/criterion-addition/log/rules

Get Proposal Logs for respective customer.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.
filter_rule_type_id	[ Integer ]	Only return results matching given rule_type.rule_type_id values.
filter_rule_level	[ CriterionAdditionRuleLevel ]	Only return results matching given defined_at.level values.
filter_rule_platform	[ AdPlatform ]	Only return results matching given rule_type.platform values.
filter_rule_campaign_type	[ CriterionAdditionRuleCampaignType ]	Only return results matching given rule_type.campaign_type values.
filter_proposal_type	[ CriterionAdditionProposalType ]	Only return results matching given rule_type.proposal_type values.
filter_criterion_type	[ CriterionAdditionCriterionType ]	Only return results matching given rule_type.criterion_type values.
filter_criterion_subtype	[ CriterionAdditionCriterionSubtype ]	Only return results matching given rule_type.criterion_subtype values.
filter_account_id	[ String ]	Only return results matching given defined_at.account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given defined_at.account_is_demo values.
filter_account_name	[ String ]	Only return results matching given defined_at.account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given defined_at.account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given defined_at.account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given defined_at.account_tags_user values.
filter_adgroup_labels	[ String ]	Only return results matching given defined_at.adgroup_labels values.
filter_adgroup_name	[ String ]	Only return results matching given defined_at.adgroup_name values.
filter_adgroup_status	[ AdgroupStatus ]	Only return results matching given defined_at.adgroup_status values.
filter_adspert_account_id	[ Integer ]	Only return results matching given defined_at.adspert_account_id values.
filter_adspert_adgroup_id	[ CompositeID ]	Only return results matching given defined_at.adspert_adgroup_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given defined_at.adspert_campaign_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given defined_at.adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given defined_at.amz_portfolio_name values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given defined_at.campaign_eby_marketplace_id values.
filter_campaign_labels	[ String ]	Only return results matching given defined_at.campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given defined_at.campaign_name values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given defined_at.campaign_optimization_support values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given defined_at.campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given defined_at.campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given defined_at.campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given defined_at.campaign_type values.
filter_log_action	[ CriterionAdditionRuleLogAction ]	Only return results matching given log_action values.
filter_log_reason	[ CriterionAdditionRuleLogReason ]	Only return results matching given log_reason values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given defined_at.performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given defined_at.performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given defined_at.performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given defined_at.performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given defined_at.performance_group_optimization_type values.
filter_user_id	[ Integer ]	Only return results matching given user_id values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where defined_at.account_id matches the given string.
search_account_name	String	Only return results where defined_at.account_name matches the given string.
search_account_tags_user	String	Only return results where defined_at.account_tags_user matches the given string.
search_adgroup_id	String	Only return results where defined_at.adgroup_id matches the given string.
search_adgroup_labels	String	Only return results where defined_at.adgroup_labels matches the given string.
search_adgroup_name	String	Only return results where defined_at.adgroup_name matches the given string.
search_adspert_account_id	String	Only return results where defined_at.adspert_account_id matches the given string.
search_amz_portfolio_id	String	Only return results where defined_at.amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where defined_at.amz_portfolio_name matches the given string.
search_campaign_id	String	Only return results where defined_at.campaign_id matches the given string.
search_campaign_labels	String	Only return results where defined_at.campaign_labels matches the given string.
search_campaign_name	String	Only return results where defined_at.campaign_name matches the given string.
search_message_details	String	Only return results where message_details matches the given string.
search_message_title	String	Only return results where message_title matches the given string.
search_performance_group_id	String	Only return results where defined_at.performance_group_id matches the given string.
search_performance_group_name	String	Only return results where defined_at.performance_group_name matches the given string.
search_user_email	String	Only return results where user_email matches the given string.
search_user_name	String	Only return results where user_name matches the given string.
sort_account_id	SortDirective	Sort results by defined_at.account_id.
sort_account_is_demo	SortDirective	Sort results by defined_at.account_is_demo.
sort_account_name	SortDirective	Sort results by defined_at.account_name.
sort_account_optimize	SortDirective	Sort results by defined_at.account_optimize.
sort_account_platform	SortDirective	Sort results by defined_at.account_platform.
sort_adgroup_id	SortDirective	Sort results by defined_at.adgroup_id.
sort_adgroup_name	SortDirective	Sort results by defined_at.adgroup_name.
sort_adgroup_status	SortDirective	Sort results by defined_at.adgroup_status.
sort_adspert_account_id	SortDirective	Sort results by defined_at.adspert_account_id.
sort_adspert_adgroup_id	SortDirective	Sort results by defined_at.adspert_adgroup_id.
sort_adspert_campaign_id	SortDirective	Sort results by defined_at.adspert_campaign_id.
sort_adspert_portfolio_id	SortDirective	Sort results by defined_at.adspert_portfolio_id.
sort_amz_portfolio_id	SortDirective	Sort results by defined_at.amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by defined_at.amz_portfolio_name.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by defined_at.campaign_eby_marketplace_id.
sort_campaign_id	SortDirective	Sort results by defined_at.campaign_id.
sort_campaign_name	SortDirective	Sort results by defined_at.campaign_name.
sort_campaign_optimization_support	SortDirective	Sort results by defined_at.campaign_optimization_support.
sort_campaign_optimization_type	SortDirective	Sort results by defined_at.campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by defined_at.campaign_optimize.
sort_campaign_status	SortDirective	Sort results by defined_at.campaign_status.
sort_campaign_type	SortDirective	Sort results by defined_at.campaign_type.
sort_performance_group_enabled	SortDirective	Sort results by defined_at.performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by defined_at.performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by defined_at.performance_group_id.
sort_performance_group_name	SortDirective	Sort results by defined_at.performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by defined_at.performance_group_optimization_type.
sort_timestamp	SortDirective	Sort results by timestamp.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
timestamp	DateTime
log_action	CriterionAdditionRuleLogAction
log_reason	CriterionAdditionRuleLogReason
message_title searchable	String
message_details searchable	String
user_id	Integer	-1 if proposal was made by Adspert.
user_email searchable	String	NULL if proposal was made by Adspert.
user_name searchable	String	Adspert user if proposal was made by Adspert.
rule_type	Object
⤷ rule_type_id	Integer	Id of the Rule Type the ruleset is defined for.
⤷ platform	AdPlatform	Platform that the Rule Type is defined for.
⤷ campaign_type	CriterionAdditionRuleCampaignType	Type of campaigns that the Rule Type is defined for.
⤷ proposal_type	CriterionAdditionProposalType	Type of the proposal.
⤷ criterion_type	CriterionAdditionCriterionType	Type of criterion proposed to be created.
⤷ criterion_subtype	CriterionAdditionCriterionSubtype	Subtype of criterion proposed to be created.
defined_at	Object
⤷ level	CriterionAdditionRuleLevel	Level of the rule.
⤷ platform	AdPlatform	Platform that the rule is defined for.
⤷ adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
⤷ account_id searchable	String	Ad platform specific ID of an advertising account.
⤷ account_name searchable	String
⤷ account_platform	AdPlatform	The account’s advertising platform.
⤷ account_optimize	Boolean	If optimization by Adspert is enabled for this account.
⤷ account_tags_user searchable	[ String ]
⤷ account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
⤷ performance_group_id searchable	Integer	Unique ID of the performance group
⤷ performance_group_name searchable	String	Unique name of the performance group.
⤷ performance_group_enabled	Boolean
⤷ performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
⤷ performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
⤷ adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
⤷ amz_portfolio_id searchable	LargeInteger
⤷ amz_portfolio_name searchable	String
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_id searchable	LargeInteger
⤷ campaign_name searchable	String
⤷ campaign_type	CampaignType
⤷ campaign_eby_marketplace_id	String
⤷ campaign_status	CampaignStatus
⤷ campaign_optimize	Boolean
⤷ campaign_optimization_type	OptimizationType
⤷ campaign_optimization_support	CampaignOptimizationSupport
⤷ campaign_labels searchable	[ String ]
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_id searchable	LargeInteger
⤷ adgroup_name searchable	String
⤷ adgroup_status	AdgroupStatus
⤷ adgroup_labels searchable	[ String ]
new	Object	Shows new/updated rule. NULL if rule was deleted.
⤷ action	CriterionAdditionRuleAction	Action that Adspert is supposed to take when generating proposals that match this rule.
⤷ catch_all	Boolean	Is the rule supposed to be used as a catch-all?
⤷ filters	[ Object ]	Additional filters that will be evaluated when matching proposals to the rule. If multiple filters are defined, all of them have to match the proposal, or else the catch-all rule will be used. Each ruleset that contains a rule with filters has to also contain exactly one catch-all rule.
⤷ operand	CriterionAdditionRuleFilterOperand	Rule filter operand.
⤷ operation	CriterionAdditionRuleFilterOperation	Rule filter operation.
⤷ values	[ Any ]	Rule filter values.
⤷ destinations	[ Object ]
⤷ destination_id	LargeInteger
⤷ destination_type	CriterionAdditionDestinationType
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. This field is populated only for SELECTED-ADGROUP destinations. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_id searchable	LargeInteger	This field is populated only for SELECTED-ADGROUP destinations.
⤷ match_type	CriterionAdditionMatchType	This field is populated only for destinations that belong to KEYWORD rules.
⤷ negative	Boolean
⤷ created_at	DateTime
⤷ effective_destination	Object	Effective destination is available only for adgroup-level requests. It’s NULL for all other levels.
⤷ campaign_id searchable	LargeInteger
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_name searchable	String
⤷ adgroup_id searchable	LargeInteger
⤷ adgroup_name searchable	String
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ product_ad_sync_mode	ProductAdSyncMode	This field is populated only when there is a product ad sync set up between the source adgroup that this rule is active for and the target adgroup referenced in this effective destination.
old	Object	Shows old/deleted rule. NULL if rule was created.
⤷ action	CriterionAdditionRuleAction	Action that Adspert is supposed to take when generating proposals that match this rule.
⤷ catch_all	Boolean	Is the rule supposed to be used as a catch-all?
⤷ filters	[ Object ]	Additional filters that will be evaluated when matching proposals to the rule. If multiple filters are defined, all of them have to match the proposal, or else the catch-all rule will be used. Each ruleset that contains a rule with filters has to also contain exactly one catch-all rule.
⤷ operand	CriterionAdditionRuleFilterOperand	Rule filter operand.
⤷ operation	CriterionAdditionRuleFilterOperation	Rule filter operation.
⤷ values	[ Any ]	Rule filter values.
⤷ destinations	[ Object ]
⤷ destination_id	LargeInteger
⤷ destination_type	CriterionAdditionDestinationType
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. This field is populated only for SELECTED-ADGROUP destinations. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ adgroup_id searchable	LargeInteger	This field is populated only for SELECTED-ADGROUP destinations.
⤷ match_type	CriterionAdditionMatchType	This field is populated only for destinations that belong to KEYWORD rules.
⤷ negative	Boolean
⤷ created_at	DateTime
⤷ effective_destination	Object	Effective destination is available only for adgroup-level requests. It’s NULL for all other levels.
⤷ campaign_id searchable	LargeInteger
⤷ adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
⤷ campaign_name searchable	String
⤷ adgroup_id searchable	LargeInteger
⤷ adgroup_name searchable	String
⤷ adspert_adgroup_id	CompositeID	Adspert internal ID of the adgroup. Composite ID specification: {adspert_account_id}:{adgroup_id}
⤷ product_ad_sync_mode	ProductAdSyncMode	This field is populated only when there is a product ad sync set up between the source adgroup that this rule is active for and the target adgroup referenced in this effective destination.

Example

http

GET /v3/customers/7027038674/criterion-addition/log/rules?search_campaign_id=dolor+amet&search_account_id=elit+dolor&search_amz_portfolio_name=lorem+tucan HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/rules?search_campaign_id=dolor+amet&search_account_id=elit+dolor&search_amz_portfolio_name=lorem+tucan' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/rules?search_campaign_id=dolor+amet&search_account_id=elit+dolor&search_amz_portfolio_name=lorem+tucan' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/rules?search_campaign_id=dolor+amet&search_account_id=elit+dolor&search_amz_portfolio_name=lorem+tucan', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "timestamp": "2018-10-21T16:45:23+02:00",
      "log_action": "CREATE",
      "log_reason": "ACCOUNT-MOVED",
      "message_title": "pariatur lorem",
      "message_details": "tucan sit",
      "user_id": 4034300999,
      "user_email": "amet tucan",
      "user_name": "adlora ipsum",
      "rule_type": {
        "rule_type_id": 5675219470,
        "platform": "AMAZON",
        "campaign_type": "AMAZON-SPONSORED-BRANDS",
        "proposal_type": "ADDITION",
        "criterion_type": "KEYWORD",
        "criterion_subtype": "ASIN"
      },
      "defined_at": {
        "level": "ACCOUNT",
        "platform": "AMAZON",
        "adspert_account_id": 123,
        "account_id": "amet lorem",
        "account_name": "vehicula ipsum",
        "account_platform": "AMAZON",
        "account_optimize": true,
        "account_tags_user": [
          "vehicula amet"
        ],
        "account_is_demo": true,
        "performance_group_id": "1245",
        "performance_group_name": "dolor sit",
        "performance_group_enabled": true,
        "performance_group_optimization_type": "CLICK",
        "performance_group_goals": [
          {
            "goal_type": "CLICKS-PER-DAY",
            "goal_value": 1.41,
            "goal_currency": "AED",
            "goal_micros": 6300000,
            "goal_ratio": 8.77
          }
        ],
        "performance_group_goal_types": [
          "CLICKS-PER-DAY"
        ],
        "adspert_portfolio_id": "123:9999",
        "amz_portfolio_id": "9999",
        "amz_portfolio_name": "elit adlora",
        "adspert_campaign_id": "123:5555",
        "campaign_id": "5555",
        "campaign_name": "sit ipsum",
        "campaign_type": "AMAZON-SPONSORED-BRANDS",
        "campaign_eby_marketplace_id": "amet pariatur",
        "campaign_status": "ACTIVE",
        "campaign_optimize": true,
        "campaign_optimization_type": "CLICK",
        "campaign_optimization_support": "SUPPORTED",
        "campaign_labels": [
          "ipsum dolor"
        ],
        "adspert_adgroup_id": "123:777",
        "adgroup_id": "777",
        "adgroup_name": "tucan lorem",
        "adgroup_status": "ACTIVE",
        "adgroup_labels": [
          "elit ipsum"
        ]
      },
      "new": {
        "action": "ADD",
        "catch_all": true,
        "filters": [
          {
            "operand": "DOMAIN",
            "operation": "CONTAINS",
            "values": [
              1
            ]
          }
        ],
        "destinations": [
          {
            "destination_id": "78046413193991906103940983",
            "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
            "adspert_adgroup_id": "123:777",
            "adgroup_id": "777",
            "match_type": "BROAD",
            "negative": true,
            "created_at": "2018-10-21T16:45:23+02:00",
            "effective_destination": {
              "campaign_id": "5555",
              "adspert_campaign_id": "123:5555",
              "campaign_name": "sit ipsum",
              "adgroup_id": "777",
              "adgroup_name": "tucan lorem",
              "adspert_adgroup_id": "123:777",
              "product_ad_sync_mode": "ADD-MISSING"
            }
          }
        ]
      },
      "old": {
        "action": "ADD",
        "catch_all": true,
        "filters": [
          {
            "operand": "DOMAIN",
            "operation": "CONTAINS",
            "values": [
              1
            ]
          }
        ],
        "destinations": [
          {
            "destination_id": "78046413193991906103940983",
            "destination_type": "AMAZON-CREATE-BRAND-KEYWORD-ADGROUP",
            "adspert_adgroup_id": "123:777",
            "adgroup_id": "777",
            "match_type": "BROAD",
            "negative": true,
            "created_at": "2018-10-21T16:45:23+02:00",
            "effective_destination": {
              "campaign_id": "5555",
              "adspert_campaign_id": "123:5555",
              "campaign_name": "sit ipsum",
              "adgroup_id": "777",
              "adgroup_name": "tucan lorem",
              "adspert_adgroup_id": "123:777",
              "product_ad_sync_mode": "ADD-MISSING"
            }
          }
        ]
      }
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "timestamp": 1
      }
    }
  }
}

FilterUserCollectionCriterionAdditionRules

GET

GET /v3/customers/(customer_id: int)/criterion-addition/log/rules/users

Get users that can be used as filters in the log endpoint.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.

Response Data (object list, json or csv or xlsx)

Name	Type	Description
user_id	Integer	Adspert user is assigned -1
user_name	String
user_email	String

Example

http

GET /v3/customers/7027038674/criterion-addition/log/rules/users?exclude=elit.amet&filter_date_le=2018-10-21&include=ipsum.amet HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/rules/users?exclude=elit.amet&filter_date_le=2018-10-21&include=ipsum.amet' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/rules/users?exclude=elit.amet&filter_date_le=2018-10-21&include=ipsum.amet' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/criterion-addition/log/rules/users?exclude=elit.amet&filter_date_le=2018-10-21&include=ipsum.amet', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "user_id": 4034300999,
      "user_name": "adlora ipsum",
      "user_email": "amet tucan"
    }
  ],
  "meta": {}
}

OptSettingsLogCollection

GET

GET /v3/customers/(customer_id: int)/opt-settings/log

Get Proposal Logs for respective customer.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given campaign_eby_marketplace_id values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_optimization_support	[ CampaignOptimizationSupport ]	Only return results matching given campaign_optimization_support values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_object_type	[ ApiOptSettingScopeEnum ]	Only return results matching given object_type values.
filter_opt_setting_type	[ OptSettingsType ]	Only return results matching given opt_setting_type values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
filter_user_id	[ Integer ]	Only return results matching given user_id values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_adspert_account_id	String	Only return results where adspert_account_id matches the given string.
search_amz_portfolio_id	String	Only return results where amz_portfolio_id matches the given string.
search_amz_portfolio_name	String	Only return results where amz_portfolio_name matches the given string.
search_campaign_labels	String	Only return results where campaign_labels matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.
search_performance_group_id	String	Only return results where performance_group_id matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
search_user_email	String	Only return results where user_email matches the given string.
search_user_name	String	Only return results where user_name matches the given string.
sort_account_id	SortDirective	Sort results by account_id.
sort_account_is_demo	SortDirective	Sort results by account_is_demo.
sort_account_name	SortDirective	Sort results by account_name.
sort_account_optimize	SortDirective	Sort results by account_optimize.
sort_account_platform	SortDirective	Sort results by account_platform.
sort_adspert_account_id	SortDirective	Sort results by adspert_account_id.
sort_adspert_campaign_id	SortDirective	Sort results by adspert_campaign_id.
sort_adspert_portfolio_id	SortDirective	Sort results by adspert_portfolio_id.
sort_amz_portfolio_id	SortDirective	Sort results by amz_portfolio_id.
sort_amz_portfolio_name	SortDirective	Sort results by amz_portfolio_name.
sort_campaign_eby_marketplace_id	SortDirective	Sort results by campaign_eby_marketplace_id.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_campaign_optimization_support	SortDirective	Sort results by campaign_optimization_support.
sort_campaign_optimization_type	SortDirective	Sort results by campaign_optimization_type.
sort_campaign_optimize	SortDirective	Sort results by campaign_optimize.
sort_campaign_status	SortDirective	Sort results by campaign_status.
sort_campaign_type	SortDirective	Sort results by campaign_type.
sort_opt_setting_type	SortDirective	Sort results by opt_setting_type.
sort_performance_group_enabled	SortDirective	Sort results by performance_group_enabled.
sort_performance_group_goal_types	SortDirective	Sort results by performance_group_goal_types.
sort_performance_group_id	SortDirective	Sort results by performance_group_id.
sort_performance_group_name	SortDirective	Sort results by performance_group_name.
sort_performance_group_optimization_type	SortDirective	Sort results by performance_group_optimization_type.
sort_timestamp	SortDirective	Sort results by timestamp.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
timestamp	DateTime
message_title	String
message_details	String
opt_setting_type	OptSettingsType	Optimization Setting types, e.g. conversion_value, conversion_value_type etc.
changelog_id	LargeInteger
object_type	ApiOptSettingScopeEnum	Optimization Settings Log scope, e.g. campaign and account.
account_id searchable	String	Ad platform specific ID of an advertising account.
adspert_account_id searchable	Integer	Adspert internal ID of the advertising account
account_platform	AdPlatform	The account’s advertising platform.
account_name searchable	String
account_is_demo	Boolean	If the account is a generated account for demonstration purposes. Demo accounts have no counterpart in the ad platform.
account_optimize	Boolean	If optimization by Adspert is enabled for this account.
account_tags_user searchable	[ String ]
adspert_campaign_id	CompositeID	Adspert internal ID of the campaign. Composite ID specification: {adspert_account_id}:{campaign_id}
campaign_name searchable	String
campaign_type	CampaignType
campaign_eby_marketplace_id	String
campaign_status	CampaignStatus
campaign_optimize	Boolean
campaign_optimization_type	OptimizationType
campaign_optimization_support	CampaignOptimizationSupport
campaign_labels searchable	[ String ]
performance_group_id searchable	Integer	Unique ID of the performance group
performance_group_name searchable	String	Unique name of the performance group.
performance_group_enabled	Boolean
performance_group_optimization_type	OptimizationType	Optimization type of the performance group. Only campaigns of the same optimization type can be added to a given performance group.
performance_group_goals	[ Object ]	List of performance group goals
⤷ goal_type	PerformanceGroupGoalType	Type of the performance group goal
⤷ goal_value	Float	Value of the performance group goal. goal_value should be NULL if goal_type is PROFIT-MAXIMIZATION. goal_value should be a ratio (> 0) if goal_type is ROAS, CRR and ROI, goal_value should be specified in micros and be larger than 10000 if goal_type is COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK.
⤷ goal_currency	Currency	Currency of the performance group goal. Currency is required for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals.
⤷ goal_micros	Micros	Value for COST-PER-DAY, COST-PER-CONVERSION and COST-PER-CLICK goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
⤷ goal_ratio	Float	Value for ROAS, CRR and ROI goals. Same as goal_value, but in a properly typed field for easier client-side handling and improved representation in tabular response data like CSV.
performance_group_goal_types	[ PerformanceGroupGoalType ]	List of performance group goal types
adspert_portfolio_id	CompositeID	Adspert internal ID of Amazon portfolio. Composite ID specification: {adspert_account_id}:{portfolio_id}
amz_portfolio_id searchable	LargeInteger
amz_portfolio_name searchable	String
user_id	Integer	-1 if proposal was made by Adspert.
user_email searchable	String	NULL if proposal was made by Adspert.
user_name searchable	String	Adspert user if proposal was made by Adspert.

Example

http

GET /v3/customers/7027038674/opt-settings/log?filter_date_le=2018-10-21&search_performance_group_name=tucan+lorem&sort_account_id=7 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/opt-settings/log?filter_date_le=2018-10-21&search_performance_group_name=tucan+lorem&sort_account_id=7' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/opt-settings/log?filter_date_le=2018-10-21&search_performance_group_name=tucan+lorem&sort_account_id=7' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/opt-settings/log?filter_date_le=2018-10-21&search_performance_group_name=tucan+lorem&sort_account_id=7', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "timestamp": "2018-10-21T16:45:23+02:00",
      "message_title": "pariatur lorem",
      "message_details": "tucan sit",
      "opt_setting_type": "ACCOUNT-CONVERSION-VALUE-SOURCE-ADDED",
      "changelog_id": "81560986721134923113934263",
      "object_type": "ACCOUNT",
      "account_id": "amet lorem",
      "adspert_account_id": 123,
      "account_platform": "AMAZON",
      "account_name": "vehicula ipsum",
      "account_is_demo": true,
      "account_optimize": true,
      "account_tags_user": [
        "vehicula amet"
      ],
      "adspert_campaign_id": "123:5555",
      "campaign_name": "sit ipsum",
      "campaign_type": "AMAZON-SPONSORED-BRANDS",
      "campaign_eby_marketplace_id": "amet pariatur",
      "campaign_status": "ACTIVE",
      "campaign_optimize": true,
      "campaign_optimization_type": "CLICK",
      "campaign_optimization_support": "SUPPORTED",
      "campaign_labels": [
        "ipsum dolor"
      ],
      "performance_group_id": "1245",
      "performance_group_name": "dolor sit",
      "performance_group_enabled": true,
      "performance_group_optimization_type": "CLICK",
      "performance_group_goals": [
        {
          "goal_type": "CLICKS-PER-DAY",
          "goal_value": 1.41,
          "goal_currency": "AED",
          "goal_micros": 6300000,
          "goal_ratio": 8.77
        }
      ],
      "performance_group_goal_types": [
        "CLICKS-PER-DAY"
      ],
      "adspert_portfolio_id": "123:9999",
      "amz_portfolio_id": "9999",
      "amz_portfolio_name": "elit adlora",
      "user_id": 4034300999,
      "user_email": "amet tucan",
      "user_name": "adlora ipsum"
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "timestamp": 1
      }
    }
  }
}

FilterUserCollectionOptSettingsLog

GET

GET /v3/customers/(customer_id: int)/opt-settings/log/users

Get users that can be used as filters in the log endpoint.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_date_ge required	Date	Only return results where filter_date_ge is equal or greater than this value.
filter_date_le required	Date	Only return results where filter_date_le is equal or lower than this value.

Response Data (object list, json or csv or xlsx)

Name	Type	Description
user_id	Integer	Adspert user is assigned -1
user_name	String
user_email	String

Example

http

GET /v3/customers/7027038674/opt-settings/log/users?filter_date_ge=2018-10-21&include=ipsum.amet&filter_date_le=2018-10-21 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/opt-settings/log/users?filter_date_ge=2018-10-21&include=ipsum.amet&filter_date_le=2018-10-21' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/opt-settings/log/users?filter_date_ge=2018-10-21&include=ipsum.amet&filter_date_le=2018-10-21' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/opt-settings/log/users?filter_date_ge=2018-10-21&include=ipsum.amet&filter_date_le=2018-10-21', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "user_id": 4034300999,
      "user_name": "adlora ipsum",
      "user_email": "amet tucan"
    }
  ],
  "meta": {}
}

Optimization Log & Stats

BiddingLogCollection

GET

GET /v3/accounts/(adspert_account_id: int)/log/bidding

Retrieve bids changed by Adspert.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_adgroup_id	[ Integer ]	Only return results matching given adgroup_id values.
filter_bid_type	[ BidType ]	Only return results matching given bid_type values.
filter_campaign_id	[ Integer ]	Only return results matching given campaign_id values.
filter_criterion_id	[ Integer ]	Only return results matching given criterion_id values.
filter_timestamp_ge	Date	Only return results where timestamp is on or after this date.
filter_timestamp_le	Date	Only return results where timestamp is on or before this date.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
sort_adgroup_id	SortDirective	Sort results by adgroup_id.
sort_adgroup_name	SortDirective	Sort results by adgroup_name.
sort_bid_new	SortDirective	Sort results by bid_new.
sort_bid_old	SortDirective	Sort results by bid_old.
sort_bid_type	SortDirective	Sort results by bid_type.
sort_campaign_name	SortDirective	Sort results by campaign_name.
sort_criterion_id	SortDirective	Sort results by criterion_id.
sort_criterion_name	SortDirective	Sort results by criterion_name.
sort_timestamp	SortDirective	Sort results by timestamp.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
timestamp	DateTime
campaign_id	Integer
campaign_name	String
adgroup_id	Integer
adgroup_name	String
criterion_id	Integer	ID of the criterion a bid has been set on. This is -1 for bids set on ad group level (a -1 may also be used for the corresponding query filter param if only ad group level bids should be returned).
criterion_name	String
bid_type	BidType
bid_old	Micros
bid_new	Micros

Example

http

GET /v3/accounts/3420379091/log/bidding?filter_timestamp_le=2018-10-21&filter_adgroup_id=1192943804&filter_bid_type=CPC HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/accounts/3420379091/log/bidding?filter_timestamp_le=2018-10-21&filter_adgroup_id=1192943804&filter_bid_type=CPC' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/accounts/3420379091/log/bidding?filter_timestamp_le=2018-10-21&filter_adgroup_id=1192943804&filter_bid_type=CPC' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/accounts/3420379091/log/bidding?filter_timestamp_le=2018-10-21&filter_adgroup_id=1192943804&filter_bid_type=CPC', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "timestamp": "2018-10-21T16:45:23+02:00",
      "campaign_id": 1111417613,
      "campaign_name": "sit ipsum",
      "adgroup_id": 1192943804,
      "adgroup_name": "tucan lorem",
      "criterion_id": 2882955073,
      "criterion_name": "dolor adlora",
      "bid_type": "CPC",
      "bid_old": 5250000,
      "bid_new": 8540000
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "timestamp": 1
      }
    }
  }
}

OptimizationStatsResource

GET

GET /v3/preview/customers/(customer_id: int)/optimization-stats

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_adspert_account_id	[ Integer ]	Only return results matching given adspert_account_id values.
filter_account_id	[ String ]	Only return results matching given account_id values.
filter_account_name	[ String ]	Only return results matching given account_name values.
filter_account_platform	[ AdPlatform ]	Only return results matching given account_platform values.
filter_account_optimize	[ Boolean ]	Only return results matching given account_optimize values.
filter_account_tags_user	[ String ]	Only return results matching given account_tags_user values.
filter_account_is_demo	[ Boolean ]	Only return results matching given account_is_demo values.
filter_performance_group_id	[ Integer ]	Only return results matching given performance_group_id values.
filter_performance_group_name	[ String ]	Only return results matching given performance_group_name values.
filter_performance_group_enabled	[ Boolean ]	Only return results matching given performance_group_enabled values.
filter_performance_group_optimization_type	[ OptimizationType ]	Only return results matching given performance_group_optimization_type values.
filter_performance_group_goal_types	[ PerformanceGroupGoalType ]	Only return results matching given performance_group_goal_types values.
filter_adspert_portfolio_id	[ CompositeID ]	Only return results matching given adspert_portfolio_id values.
filter_amz_portfolio_name	[ String ]	Only return results matching given amz_portfolio_name values.
filter_adspert_campaign_id	[ CompositeID ]	Only return results matching given adspert_campaign_id values.
filter_campaign_name	[ String ]	Only return results matching given campaign_name values.
filter_campaign_type	[ CampaignType ]	Only return results matching given campaign_type values.
filter_campaign_eby_marketplace_id	[ String ]	Only return results matching given eby_marketplace_id values.
filter_campaign_status	[ CampaignStatus ]	Only return results matching given campaign_status values.
filter_campaign_optimize	[ Boolean ]	Only return results matching given campaign_optimize values.
filter_campaign_optimization_type	[ OptimizationType ]	Only return results matching given campaign_optimization_type values.
filter_campaign_labels	[ String ]	Only return results matching given campaign_labels values.
filter_date_ge required	Date	Aggregate data where date is on or after this date.
filter_date_le required	Date	Aggregate data where date is on or before this date.
search_account_id	String	Only return results where account_id matches the given string.
search_account_name	String	Only return results where account_name matches the given string.
search_account_tags_user	String	Only return results where account_tags_user matches the given string.
search_performance_group_name	String	Only return results where performance_group_name matches the given string.
search_portfolio_name	String	Only return results where portfolio_name matches the given string.
search_campaign_name	String	Only return results where campaign_name matches the given string.

Response Data (single object, json or csv or xlsx)

Name	Type	Description
optimized_campaigns	Integer	Number of optimized campaigns.
added_biddable_criteria	Integer	Number of biddable criteria, added by Adspert.
added_negative_criteria	Integer	Number of negative criteria, added by Adspert.
added_criteria_clicks	Integer	Number of clicks generated by criteria added by Adspert.
added_criteria_conversions	Integer	Number of conversions generated by criteria added by Adspert.
added_criteria_conversions_adjusted	Integer	Number of conversions generated by criteria added by Adspert (adjusted for conversion delay).
submitted_bids	Integer	Number of bids submitted by Adspert.
submitted_bid_modifiers	Integer	Number of bid modifiers submitted by Adspert.

Example

http

GET /v3/preview/customers/7027038674/optimization-stats?filter_account_is_demo=True&exclude=elit.amet&filter_date_le=2018-10-21 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/preview/customers/7027038674/optimization-stats?filter_account_is_demo=True&exclude=elit.amet&filter_date_le=2018-10-21' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/preview/customers/7027038674/optimization-stats?filter_account_is_demo=True&exclude=elit.amet&filter_date_le=2018-10-21' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/preview/customers/7027038674/optimization-stats?filter_account_is_demo=True&exclude=elit.amet&filter_date_le=2018-10-21', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": {
    "optimized_campaigns": 7513044662,
    "added_biddable_criteria": 7634984109,
    "added_negative_criteria": 4778055772,
    "added_criteria_clicks": 7092403479,
    "added_criteria_conversions": 8103854293,
    "added_criteria_conversions_adjusted": 6617614278,
    "submitted_bids": 6904863387,
    "submitted_bid_modifiers": 6137890988
  },
  "meta": {}
}

Miscellaneous

Endpoints which do not fit into any other category.

Retail Accounts

RetailAccountsCollection

GET

GET /v3/customers/(customer_id: int)/retail-accounts

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_access_status	[ RetailAccessStatus ]	Only return results matching given access_status values.
filter_retail_account_id	[ String ]	Only return results matching given retail_account_id values.
filter_retail_account_platform	[ AdPlatform ]	Only return results matching given retail_account_platform values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
search_accounts	String	Only return results where accounts matches the given string.
search_retail_account_name	String	Only return results where retail_account_name matches the given string.
sort_access_status	SortDirective	Sort results by access_status.
sort_retail_account_id	SortDirective	Sort results by retail_account_id.
sort_retail_account_name	SortDirective	Sort results by retail_account_name.
sort_retail_account_platform	SortDirective	Sort results by retail_account_platform.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
retail_account_id	String	Retail account id.
retail_account_name searchable	String	Retail account name.
retail_account_platform	AdPlatform	The account’s advertising platform.
access_status	RetailAccessStatus	Indicates access to retail account platform.
accounts searchable	[ Object ]
⤷ account_id	String
⤷ account_name	String

Example

http

GET /v3/customers/7027038674/retail-accounts?include=ipsum.amet&sort_retail_account_name=5&sort_access_status=3 HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/customers/7027038674/retail-accounts?include=ipsum.amet&sort_retail_account_name=5&sort_access_status=3' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/customers/7027038674/retail-accounts?include=ipsum.amet&sort_retail_account_name=5&sort_access_status=3' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/customers/7027038674/retail-accounts?include=ipsum.amet&sort_retail_account_name=5&sort_access_status=3', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "retail_account_id": "vehicula lorem",
      "retail_account_name": "pariatur sit",
      "retail_account_platform": "AMAZON",
      "access_status": "NO-ACCESS",
      "accounts": [
        {
          "account_id": "amet lorem",
          "account_name": "vehicula ipsum"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "retail_account_id": 1
      }
    }
  }
}

Currency Rates

CurrencyRateCollection

GET

GET /v3/currency-rates

Retrieve a list of currency rates.

Auth mode:

api-token

Access level:

user

Query Params

Name	Type	Description
include	[ ResponseFieldReference ]	Fields to include in response data.
exclude	[ ResponseFieldReference ]	Fields to exclude in response data.
filter_currency	[ String ]	Only return results matching given currency values.
search_fields	[ SearchableResponseFieldReference ]	Fields that should be searched using the search_term.
search_term	String	Search term used to search the search_fields.
sort_currency	SortDirective	Sort results by currency.
sort_rate_from_eur	SortDirective	Sort results by rate_from_eur.
offset	Integer	Start index for result list. Default: 0 Min value: 0
limit	Integer	Maximum number of results to return. The maximum allowed value depends on the response media type (10000 for JSON and 100000 for tabular formats like CSV). Default: 10 Min value: 1

Response Data (object list, json or csv or xlsx)

Name	Type	Description
currency	String	ISO 4217 currency code
rate_from_eur	Float	Exchange rate from EUR to currency

Example

http

GET /v3/currency-rates?sort_rate_from_eur=1&sort_currency=7&search_term=vehicula+ipsum HTTP/1.1
Host: api.adspert.net
Accept: application/json
Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5...

curl

curl -i -X GET 'https://api.adspert.net/v3/currency-rates?sort_rate_from_eur=1&sort_currency=7&search_term=vehicula+ipsum' -H "Accept: application/json" -H "Authorization: Bearer 433126ffa47f453c21f26d9f15ea11f5..."

httpie

http 'https://api.adspert.net/v3/currency-rates?sort_rate_from_eur=1&sort_currency=7&search_term=vehicula+ipsum' Accept:application/json Authorization:"Bearer 433126ffa47f453c21f26d9f15ea11f5..."

python-requests

requests.get('https://api.adspert.net/v3/currency-rates?sort_rate_from_eur=1&sort_currency=7&search_term=vehicula+ipsum', headers={'Accept': 'application/json', 'Authorization': 'Bearer 433126ffa47f453c21f26d9f15ea11f5...'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": [
    {
      "currency": "USD",
      "rate_from_eur": "1.1883"
    }
  ],
  "meta": {
    "pagination": {
      "offset": 0,
      "limit": 10,
      "total": 74,
      "sort": {
        "currency": 1
      }
    }
  }
}

API Status Check

StatusResource

GET

GET /v3/status

A simple status check to check API availability.

Example

http

GET /v3/status HTTP/1.1
Host: api.adspert.net
Accept: application/json

curl

curl -i -X GET https://api.adspert.net/v3/status -H "Accept: application/json"

httpie

http https://api.adspert.net/v3/status Accept:application/json

python-requests

requests.get('https://api.adspert.net/v3/status', headers={'Accept': 'application/json'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

WorkerStatusResource

GET

GET /v3/status/worker

A simple status check to test API worker responsiveness.

Example

http

GET /v3/status/worker HTTP/1.1
Host: api.adspert.net
Accept: application/json

curl

curl -i -X GET https://api.adspert.net/v3/status/worker -H "Accept: application/json"

httpie

http https://api.adspert.net/v3/status/worker Accept:application/json

python-requests

requests.get('https://api.adspert.net/v3/status/worker', headers={'Accept': 'application/json'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

Web hook endpoints for external services

StripeWebHookResource

POST

POST /v3/hooks/stripe

Example

http

POST /v3/hooks/stripe HTTP/1.1
Host: api.adspert.net
Accept: application/json

curl

curl -i -X POST https://api.adspert.net/v3/hooks/stripe -H "Accept: application/json"

httpie

http POST https://api.adspert.net/v3/hooks/stripe Accept:application/json

python-requests

requests.post('https://api.adspert.net/v3/hooks/stripe', headers={'Accept': 'application/json'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

EbayWebHookAccountDelete

GET

GET /v3/hooks/ebay/delete-notifications

Example

http

GET /v3/hooks/ebay/delete-notifications HTTP/1.1
Host: api.adspert.net
Accept: application/json

curl

curl -i -X GET https://api.adspert.net/v3/hooks/ebay/delete-notifications -H "Accept: application/json"

httpie

http https://api.adspert.net/v3/hooks/ebay/delete-notifications Accept:application/json

python-requests

requests.get('https://api.adspert.net/v3/hooks/ebay/delete-notifications', headers={'Accept': 'application/json'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

POST

POST /v3/hooks/ebay/delete-notifications

Example

http

POST /v3/hooks/ebay/delete-notifications HTTP/1.1
Host: api.adspert.net
Accept: application/json

curl

curl -i -X POST https://api.adspert.net/v3/hooks/ebay/delete-notifications -H "Accept: application/json"

httpie

http POST https://api.adspert.net/v3/hooks/ebay/delete-notifications Accept:application/json

python-requests

requests.post('https://api.adspert.net/v3/hooks/ebay/delete-notifications', headers={'Accept': 'application/json'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

EbayWebHookBudgetStatus

GET

GET /v3/hooks/ebay/budget-status-notifications

Example

http

GET /v3/hooks/ebay/budget-status-notifications HTTP/1.1
Host: api.adspert.net
Accept: application/json

curl

curl -i -X GET https://api.adspert.net/v3/hooks/ebay/budget-status-notifications -H "Accept: application/json"

httpie

http https://api.adspert.net/v3/hooks/ebay/budget-status-notifications Accept:application/json

python-requests

requests.get('https://api.adspert.net/v3/hooks/ebay/budget-status-notifications', headers={'Accept': 'application/json'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

POST

POST /v3/hooks/ebay/budget-status-notifications

Example

http

POST /v3/hooks/ebay/budget-status-notifications HTTP/1.1
Host: api.adspert.net
Accept: application/json

curl

curl -i -X POST https://api.adspert.net/v3/hooks/ebay/budget-status-notifications -H "Accept: application/json"

httpie

http POST https://api.adspert.net/v3/hooks/ebay/budget-status-notifications Accept:application/json

python-requests

requests.post('https://api.adspert.net/v3/hooks/ebay/budget-status-notifications', headers={'Accept': 'application/json'})

response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "message": "OK",
  "data": null,
  "meta": {}
}

---

Release 3.33.34

© 2024 Adspert • Privacy • Terms • Imprint • Contact