Skip to main content

Standard Data Feeds

myKaarma offers a set of standard reporting data feeds that are available to you out of the box, with no custom setup required. Each feed is delivered as a CSV file and contains one row per event of that type.

The standard data feeds we currently offer are:

  1. Order Data Feed
  2. MPI Data Feed
  3. Appointment Data Feed
  4. Customer Data Feed

Delivery​

Each standard data feed is delivered on a recurring schedule to an SFTP server. We support the following delivery frequencies:

  • Daily — a new file is delivered every day.
  • Weekly — a new file is delivered once a week.
  • Monthly — a new file is delivered once a month.

Order Data Feed​

The Order Data Feed contains one row per order updated in the previous time window.

MPI Data Feed​

The MPI Data Feed contains one row per multi-point inspection (MPI) updated in the previous time window.

Appointment Data Feed​

The Appointment Data Feed contains one row per appointment updated in the previous time window.

Customer Data Feed​

The Customer Data Feed contains one row per customer updated in the previous time window.

Raw Event Payload Column​

Every standard data feed above includes a column containing the raw JSON payload of the underlying event that produced that row. This gives you access to the complete event data, which represents the latest state of the object at the end of day.

To see the full schema for this JSON — every field, its type, and what it means — refer to the matching event page in our myKaarma Webhooks documentation:

Data FeedRaw JSON Column Schema
Order Data FeedOrder Event
MPI Data FeedMPI Event
Appointment Data FeedAppointment Event
Customer Data FeedCustomer Event

Additional (Optional) Columns​

On top of the standard columns for any of the feeds above, you can choose to have the following additional columns added to your feed:

  • Dealer UUID — the dealership's universally unique identifier.
  • Dealer Name — the dealership's name.
  • Dealer Code — the dealership's OEM code.
  • Dealer Brand — the brand associated with the dealership.

File Size Limits​

There is currently no upper limit on file size. The resulting size of a given file will vary depending on the type of data requested, the date range, and overall product usage.