Is it possible to get usage data on macros, triggers, and automations?

Question

Can I get specific usage data on macros, triggers, and automations?

Answer

Disclaimer: This article is provided for instructional purposes only. Zendesk does not support or guarantee the code. Post any issues you have in the comments section or try searching for a solution online.

Although it is not possible to pull this kind of usage data for a specific date, you can obtain usage data for macros, triggers, and automations based on the last hour, 24 hours, 7 days, or 30 days through the API. There are two different types of API calls you can make to obtain this usage data.

While managing your triggers, you can view or add columns that display how often the trigger has fired in the last 24 hours, 7 days, or 30 days. Managing macros or automations allows you to view how often they have been executed in the last 7 day period.

Option 1: Filtered API Request

Make a filtered request for each. The parameters described below are supported when filtering this information via the API.

• usage_1h
• usage_24h
• usage_7d

Example:

https://yoursubdomain.zendesk.com/api/v2/macros.json?sort_by=usage_1h,usage_24h,usage_7d

Make sure you're logged in, then select your subdomain from the dropdown below to be redirected directly to this API call in your account.

Choose subdomain

.zendesk.com Go to account

Option 2: Sideload API Request

Make a sideload request to obtain the usage data for each. Sideloading gives you an option for tracking usage over a larger amount of time by allowing you to add the parameter of 30 days to the request. The sideloading parameters described below are currently supported.

• usage_1h
• usage_24h
• usage_7d
• usage_30d 

Example:

https://yoursubdomain.zendesk.com/api/v2/macros.json?include=usage_1h,usage_24h,usage_7d

Note: Usage parameters for macros are only accessible with a Support Enterprise plan level.  

The API calls yield all macros, triggers, and automations in your account.  The usage is displayed by the number of times that object was used during each parameter set. For more information on using the API to track usage data, see the developer documentation on macros, triggers, and automations.

Note: These API requests only display personal macros for the user that is making the request. To track the use of all personal macros, each user has to make a separate API call for their own personal macros.