Reporting API Overview

The Reporting API enables you to track changes for all your users’ data held on the MX platform without having to read this data individually for each user. It programmatically pulls MX’s data into your system on a per-client basis and provides daily change files that indicate how objects have changed throughout the day. This data is requested by providing the date, resource, and action.

All API responses are in an Avro file format. More information about Avro can be found on the official Avro documentation page. Avro files rely on schemas. When Avro data is read, the schema used when writing it is always present. This permits each datum to be written with no per-value overheads, making serialization both fast and small. This also facilitates use with dynamic scripting languages since data, together with its schema, is fully self-describing.

The resources available and the fields included for each are listed. We have included a list of what fields are recorded and written into these log files, but we may add additional fields at any time. See the schema evolution section for more information.

If a particular resource has no data for a given day, an Avro file with headers but no body is generated and made available for retrieval.