DataFlex / Support API / Export Search Results
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sCreated_at
String sDefault
String sDeleted
String sDescription
String sId
String sName
String sResult_type
String sUpdated_at
String sUrl
String sFacets
String sV_Next
String sPrev
String sAfter_cursor
String sBefore_cursor
String sHas_more
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "login"
Set ComPassword Of hoHttp To "password"
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "query" "<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "page[size]" "<integer>" To iSuccess
Get ComUpdateString Of hoQueryParams "filter[type]" "<string>" To iSuccess
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://example.zendesk.com/api/v2/search/export" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "facets": "<string>",
// "links": {
// "next": "<string>",
// "prev": "<string>"
// },
// "meta": {
// "after_cursor": "<string>",
// "before_cursor": "<string>",
// "has_more": "<boolean>"
// },
// "results": [
// {
// "created_at": "<string>",
// "default": "<boolean>",
// "deleted": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "name": "<string>",
// "result_type": "<string>",
// "updated_at": "<string>",
// "url": "<string>"
// },
// {
// "created_at": "<string>",
// "default": "<boolean>",
// "deleted": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "name": "<string>",
// "result_type": "<string>",
// "updated_at": "<string>",
// "url": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "facets" To sFacets
Get ComStringOf Of hoJResp "links.next" To sV_Next
Get ComStringOf Of hoJResp "links.prev" To sPrev
Get ComStringOf Of hoJResp "meta.after_cursor" To sAfter_cursor
Get ComStringOf Of hoJResp "meta.before_cursor" To sBefore_cursor
Get ComStringOf Of hoJResp "meta.has_more" To sHas_more
Move 0 To i
Get ComSizeOfArray Of hoJResp "results" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "results[i].created_at" To sCreated_at
Get ComStringOf Of hoJResp "results[i].default" To sDefault
Get ComStringOf Of hoJResp "results[i].deleted" To sDeleted
Get ComStringOf Of hoJResp "results[i].description" To sDescription
Get ComStringOf Of hoJResp "results[i].id" To sId
Get ComStringOf Of hoJResp "results[i].name" To sName
Get ComStringOf Of hoJResp "results[i].result_type" To sResult_type
Get ComStringOf Of hoJResp "results[i].updated_at" To sUpdated_at
Get ComStringOf Of hoJResp "results[i].url" To sUrl
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -u login:password -G -d "query=%3Cstring%3E"
-d "page[size]=%3Cinteger%3E"
-d "filter[type]=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/search/export
Postman Collection Item JSON
{
"name": "Export Search Results",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/search/export?query=<string>&page[size]=<integer>&filter[type]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"search",
"export"
],
"query": [
{
"key": "query",
"value": "<string>",
"description": "(Required) The search query. See [Query basics](#query-basics) above. For details on the query syntax, see the [Zendesk Support search reference](https://support.zendesk.com/hc/en-us/articles/203663226)"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "The number of results shown in a page."
},
{
"key": "filter[type]",
"value": "<string>",
"description": "The object type returned by the export query. Can be `ticket`, `organization`, `user`, or `group`."
}
]
},
"description": "Exports a set of results. See [Query basics](#query-basics) for the syntax of the `query` parameter.\n\nThis endpoint is for search queries that will return more than 1000 results. The result set is ordered only by the `created_at` attribute.\n\nThe search only returns results of a single object type. The following object types are supported: ticket, organization, user, or group.\n\nYou must specify the type in the `filter[type]` parameter. Searches with type in the query string will result in an error.\n\n#### Allowed For\n\n- Agents\n\n#### Pagination\n\n- Cursor pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 1000 records per page. The number of results shown in a page is determined by the `page[size]` parameter.\n\n**Note**: You may experience a speed reduction or a timeout if you request 1000 results per page and you have many archived tickets in the results. Try reducing the number of results per page. We recommend 100 results per page.\n\nThe cursor specified by the `after_cursor` property in a response expires after one hour.\n\nFor more information on cursor-based pagination, see the following articles:\n\n- [Comparing cursor pagination and offset pagination](/documentation/developer-tools/pagination/comparing-cursor-pagination-and-offset-pagination)\n- [Paginating through lists using cursor pagination](/documentation/developer-tools/pagination/paginating-through-lists-using-cursor-pagination)\n\n#### Limits\n\nThis API endpoint is rate-limited to 100 requests per minute per account. The limit also counts towards the global API rate limit.\n\n#### Response Format\n\n| Name | Type | Comment\n| --------------------- | ---------------------| --------------------\n| links[next] | string | URL to the next page of results\n| meta[has_more] | string | Boolean indicating if there are more results\n| meta[after_cursor] | string | Cursor object returned from the Search Service\n| results | array | May consist of tickets, users, groups, or organizations, as specified by the `filter_type` parameter\n\nThe response is similar to the response of `GET /api/v2/search.json?`, with a few changes:\n\n* `links` - Has the following nested properties: `prev` and `next`. These replace the `next_page` and `prev_page` links. The `prev` property is always null because backward pagination is not supported. The `next` property may include an auto-generated link to the next page of results.\n* `meta` - Has the following nested properties: `has_more` and `after_cursor`. The `has_more` property indicates whether the next page has more results. The `after_cursor` property is the cursor used to paginate to the next page. It expires after one hour.\n\nThere's no `count` property.\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/search/export?query=<string>&page[size]=<integer>&filter[type]=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"search",
"export"
],
"query": [
{
"key": "query",
"value": "<string>",
"description": "(Required) The search query. See [Query basics](#query-basics) above. For details on the query syntax, see the [Zendesk Support search reference](https://support.zendesk.com/hc/en-us/articles/203663226)"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "The number of results shown in a page."
},
{
"key": "filter[type]",
"value": "<string>",
"description": "The object type returned by the export query. Can be `ticket`, `organization`, `user`, or `group`."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"facets\": \"<string>\",\n \"links\": {\n \"next\": \"<string>\",\n \"prev\": \"<string>\"\n },\n \"meta\": {\n \"after_cursor\": \"<string>\",\n \"before_cursor\": \"<string>\",\n \"has_more\": \"<boolean>\"\n },\n \"results\": [\n {\n \"created_at\": \"<string>\",\n \"default\": \"<boolean>\",\n \"deleted\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"result_type\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"created_at\": \"<string>\",\n \"default\": \"<boolean>\",\n \"deleted\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"result_type\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
