How Do I Set Up a Performance Data API Integration?

Last updated: November 17, 2026

A Performance Data API integration gives your developers a secure web address that their systems can post activity data to, and Ambition turns that data into metrics. New integrations start in Sandbox Mode, so you can test your data before any metrics are shown to users.

Required permissions:

  • The Integrations: Edit permission is required to set up a Performance Data API integration.

Enable the API Integration

  1. Go to Admin --> Data --> Integrations.

  2. Open the Available tab and search for "Performance Data API" in the Find an integration search box.

  3. Click on Enable in the Performance Data API row. You'll then be taken to the integration's Settings page.

Name the Integration and Choose a Contact Person

  1. Enter a name that describes the system or data being sent, such as "Dialer Calls", in the Integration Name field.

  2. Enter the email of the person Ambition should contact about problems with this integration in the Admin Email Address field.

  3. Click on Save. A message confirming the settings were saved will appear.

  4. Optional: Turn on the Admin Notifications toggle to email that contact when no data arrives for the previous business day.

Set Up the Data Format Page

Add Data Formatting Details

  1. Open the Data Format page from the integration's side menu.

  2. Select JSON or CSV under Data Format, based on what your developers will post.

  3. Optional: If your JSON has nested objects or lists, use the JSON Transformer section that will appear to flatten them.

  4. Select Records under Data Schema if each entry is a single activity, or Daily Totals if each entry is one user's total for one day.

Add the Fields that Will Appear in Uploads

  1. Update the starter rows in the Field Mappings table so they match your data. Records begins with an id row, and Daily Totals begins with email and date rows.

  2. Click on Add Field Mapping once for each remaining key your developers will send.

  3. Enter the key in the Field Key field, matching the spelling and capitalization in your data.

  4. Enter a user-friendly name for the key in the Display Name field.

  5. Select the kind of value the key holds, such as Unique Record Identifier, Email Address, Date/Time, or Number, from the Field Type drop-down menu.

  6. Click on Save Data Format. You'll then see the Please confirm before saving pop-up.

  7. Make sure the pop-up lists your keys under User Identification and Date Fields.

  8. Enter "I UNDERSTAND" in the text box.

  9. Click on Confirm to apply your changes.


Related Articles