Ecommerce

Handle data related to ImBox Ecommerce tracker.

If you would like to export all the data inside the ecommerce tracker found on admin.imbox.io/api/analytic/ecommerce you can use this API.

transactions

Lists all transactions within a given timespan.

Parameters

Name	Type	Description
apiKey*	String	Your API key
userId*	String	Unique id for the user

Query parameters

Name	Type	Description
startTime*	String	Format: YYYY-MM-DD
endTime*	String	Format: YYYY-MM-DD

Usage

curl -X GET "https://apiv2.imbox.io/api/ecommerceTransactions/:apiKey/:userId?startTime=2020-01-01&endTime=2020-01-02"

Response

{
  "result": "success",
  "json": [
    {
      "channel": "V1",
      "agentEmail": "john.doe@example.org",
      "transId": "1",
      "price": 1337,
      "custom1": "Custom value 1",
      "custom2": "Custom value 2",
      "custom3": "Custom value 3",
      "hasHadChat": true,
      "timestamp": "2020-00-00T00:00:00.000Z"
    },
    {
      "channel": "V2",
      "agentEmail": null,
      "transId": "2",
      "price": 1337,
      "custom1": "Custom value 1",
      "custom2": "Custom value 2",
      "custom3": "Custom value 3",
      "hasHadChat": false,
      "timestamp": "2020-00-00T00:00:00.000Z"
    }
  ],
  "length": 2
}

API key scope access

Configure API key access in ImBox Admin dashboard.

Scope	Access
Ecommerce	Read