Fetch historic e-commerce balances for an account

Fetch balances for a connected e-commerce account starting from a specific date till today by providing the from_date. Once InsightIQ processes the request, you can fetch the updated balances by calling the retrieve e-commerce balances API.

Subscribe to the "BALANCES.ADDED" and "BALANCES.UPDATED" webhooks to receive a notification once the request is completed. With webhooks, you should use the retrieve e-commerce balances in bulk API for optimal performance.

Check the category field from the work platform API response or the "Category" column in this data guide to see which platfroms we serve under "commerce".

POST /v1/commerce/income/balances/fetch-historic

Basic auth

curl 'https://api.sandbox.insightiq.ai/v1/commerce/income/balances/fetch-historic' \
  --request POST \
  --header 'Authorization: Basic YOUR_BASE64_CREDENTIALS' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  "from_date": "2019-08-24"
}'

{
  "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  "from_date": "2019-08-24"
}

Accepted

Body

· FetchHistoric

application/json

account_id string · uuid required

Unique ID of the account.

from_date string · date required

Starting date from which the content items need to be refreshed, in YYYY-MM-DD format.

Body

Responses