TABLE OF CONTENTS


A reporting API integration will allow you to fetch data from ACME reports without a user having to go into ACME and manually triggering the report to run. You can then save that data to a specific location, import it to another system, or do whatever you need with it. Some example use cases are:

  1. Pull a specific data set to use for communicating with guests via MailChimp or another email marketing tool
  2. Pull data to import into an analysis tool such as Dexibit or Power BI
  3. Pull data and save the results to a local server or specific location for easy access for other staff/departments

Step 1: Review the Reporting API documentation


Step 2: Configure your reports in ACME

  • You may be looking to access reports that you are already using, or you may need to make changes or new reports altogether. Set up the report(s) you need with the filters, outputs, and time ranges that you will need. Make note of the ID displayed in the URL when viewing that report(s), to use when making the API calss


Step 3: Configure a user name and request an API key

  • Create a general user (not an email user) with a use specific username (like 'api_dexibit' or 'api_reports') and set a default password
  • Create a new group, or assign to an existing group. Ensure that the group has roles with the following permissions (all from the Reports Admin role):
    • REPORTS_VIEW

    • REPORTS_CREATE

    • REPORTS_EXECUTE

    • REPORTS_UPDATE

    • REPORTS_DOWNLOAD

    • REPORTS_DELETE

  • Send an email to api-help@acmeticketing.com to request an API key for this user


Once you have an API key and the ID(s) of the reports you want to pull, you can use them to make the API calls!