GET /api/v2/views/{view_id}/execute
Returns the column titles and the rows of the specified view.
The columns array lists the view's column titles and includes only views parameters.
The rows array lists the values of each column for each ticket and includes parameters from both views and tickets. Though not displayed in the view, a partial ticket object is included with each row object.
Note: To get the full ticket objects for a specified view, use List Tickets from a View.
This endpoint is rate limited to 5 requests per minute, per view, per agent. This rate limit includes activity in Zendesk Support. An API script is more likely to encounter rate limit errors if the authenticating agent or admin is concurrently active in Zendesk Support.
The view execution system is designed for periodic rather than high-frequency API usage. In particular, views called very frequently may be cached by Zendesk. This means that the API client will still receive a result, but that result may have been computed at any time within the last 10 minutes.
Zendesk recommends using the Incremental Ticket Export endpoint to get the latest changes. You can call it more often, and it returns all the tickets that changed since the last poll. For details and rate limits, see Incremental Exports.
View output sorting can be controlled by passing the sort_by and sort_order parameters in the format described in the table in Preview Views.
Allowed For
- Agents
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
view_id |
Integer | Yes |
The ID of the view |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
No |
Pagination parameter. Supports both traditional offset and cursor-based pagination:
These are mutually exclusive - use one format or the other, not both. |
|
sort_order |
String | No |
The direction the tickets are sorted. May be one of 'asc' or 'desc' |
group_by |
String | No |
The ticket field used for grouping. This will either be a title or a custom field id. |
include |
String | No |
A comma-separated list of sideloads to include in the response. |
sort_by |
String | No |
The ticket field used for sorting. This will either be a title or a custom field id. |
exclude |
String | No |
A comma-separated list of sideloads to exclude from the response. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.