/advan/brands

POST /api/advan/brands

Price: 1 credit

Get a brand's or NAICS industry's consumer card spend from Advan Research SpendView: monthly spend and transactions, the in-store and online split, the top state with its basket-size distribution, and the top cities

How to use it

Pass the alias from advan/brands/search. Money is in US dollars and counts are absolute numbers. The monthly series covers January 2019 to June 2021, and the channel split and the top state describe May 2021.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• brand string required — Brand or industry alias, or its Advan Research spend page URL (examples: "adidas", "naics-448120", "https://advanresearch.com/spend-data/walmart"; minLength: 1)

Response

• @type string (default: "AdvanBrand")
• alias string required
• name string required
• url string required
• kind string required (one of: "brand", "industry")
• naics_code string nullable
• data_window string nullable
• first_month string nullable
• last_month string nullable
• total_spend number nullable
• spend_summary string nullable
• monthly array (default: [])
  • @type string (default: "AdvanSpendMonth")
  • month string required
  • spend number nullable
  • transaction_count integer nullable
• channel_month string nullable
• in_store_share number nullable
• online_share number nullable
• channel_summary string nullable
• channels array (default: [])
  • @type string (default: "AdvanSpendChannel")
  • channel string required
  • spend number nullable
  • transaction_count integer nullable
  • average_basket number nullable
  • is_total boolean (default: false)
• top_state object nullable
  • @type string (default: "AdvanTopState")
  • name string required
  • month string nullable
  • spend number nullable
  • transaction_count integer nullable
  • customer_count integer nullable
  • average_basket number nullable
  • visits_per_customer number nullable
  • summary string nullable
  • basket_distribution array (default: [])
    • @type string (default: "AdvanBasketBucket")
    • basket_range string required
    • spend_share number nullable
    • transaction_share number nullable
• top_cities array (default: [])
  • @type string (default: "AdvanTopCity")
  • city string required
  • spend number nullable
  • transaction_count integer nullable
  • average_basket number nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Advan Research has no spend page for this alias Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.