Report API

This API is intended to handle infrequent periodic automated requests to pull report-like data. It is not intended to handle frequent requests as part of any real-time integration. If you make too many frequent requests, your access to the Report API may be restricted or blocked.

To make a request, you must POST to this URL with JSON data as the BODY of the posted request, and with your account's API Key in a field named "api_key" in that JSON.

To get your API Key, contact your support rep.

A simple sample request is below, for all registrations (from the productRegistration resource) on a specific day, including some information about the User and the Product from those related resources.

To include a field from them main resource, in the fields section, add a field by name. See the example for "price_before_discount" below.

Related Resources: In the docs area for each resource below, you will find "Relations" these are the tags/names for other resources that have built-in relationships with the main resource... For example, productRegistration has relationships with user, product, etc.

To include a single field from a related resource, in the fields section, add a field with a name compounded of the related resource name, a period, and the field name. See the example for "user.firstname" below.

To include multiple fields from a related resource, grouped into a sub-element of the results, use a JSON sub-element, as shown in the example for product title and product remote_product_id

The best way to learn how to use this API is to make test requests using a tool like PostMan.

{
  "api_key":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "format":"json",
    "labels":false,
    "resource":"productRegistration",
    "fields":{
      "price_before_discount":true,
      "amount_discounted":true,
      "price_after_discount":true,
      "transaction_at":true,
      "user.firstname":true,
      "user.lastname":true,
      "user.email":true,
      "product": {
        "title": true,
        "remote_product_id": true
      }
    },
  "filters":{
    "transaction_at":{">=":"2021-04-06 00:00:00", "<=":"2021-04-06 23:59:59"}
  }
}
                    

Do not send the same field key twice in one JSON object. JSON keys must be unique — the second key will overwrite the first, and you will lose that condition.

Preferred: put all conditions for a field into a single object, as shown in the filters example above. This ensures all conditions are applied and prevents accidental overwriting.

Not preferred: repeating the same field key in the same object, which can overwrite conditions and cause data loss.

For further guidance, and/or to have one of our programmers suggest a query to return the data you want, contact your support rep.