The following object types are supported: ticket, organization, user, or group. The search only returns results of a single object type. The result set is ordered only by the created_at attribute. This endpoint is for search queries that will return more than 1000 results. See Query basics for the syntax of the query parameter. api/v2/search.json?query=Įxports a set of results. You specify search queries in a URL parameter named query: For example, if a query has 5,000 results, the count value will be 5,000, even if the API only returns the first 1,000 results. The count property shows the actual number of results. You can also use the Export endpoint.Īlternatively, if you only want incremental changes based on the most recent change, consider using one of the Incremental Export endpoints. If you need to retrieve large datasets, Zendesk recommends breaking up the search into smaller chunks by limiting results to a specific date range. If you request a page past the limit ( page=11 at 100 results per page), a 422 Insufficient Resource Error is returned. The Search API returns up to 1,000 results per query, with a maximum of 100 results per page. If new resources don't appear in your search results, wait a few minutes and try again. Note: It can take up to a few minutes for new tickets, users, and other resources to be indexed for search. To use the API with Python or Perl, see Searching with the Zendesk API. To search articles in Help Center, see Search in the Help Center API documentation.
You can define filters to narrow your search results according to resource type, dates, and object properties, such as ticket requester or tag. The Search API is a unified search API that returns tickets, users, and organizations.
0 kommentar(er)
