Export Process Events Search Results with Jobs Service
POST {{cb_url}}/jobs/v1/orgs/{{cb_org_key}}/jobs/start/event_export
This is a specific example for exporting Process Events which uses the generic Jobs Service. The sequence to use the jobs services is
- Start an Export Event Job (this call)
- Check the job has completed with Get Job Progress
- Download the Job Output. The response is a zipped csv file of results.
| Permission (.notation name) | Operation(s) |
|---|---|
| jobs.status | READ |
| org.search.events | CREATE |
Full documentation is available on the Developer Network
Request Body
{"api_resource"=>"PROCESS_EVENTS", "version"=>"v2", "query"=>{"criteria"=>{}, "exclusions"=>{}, "query"=>"*:*", "time_range"=>{"start"=>"2023-03-26T02:00:00.000Z", "end"=>"2023-03-29T02:06:20.864Z"}, "rows"=>10000, "fields"=>["*"], "sort"=>[{"field"=>"device_timestamp", "order"=>"DESC"}]}}
RESPONSES
status: Created
{"id":5742539,"type":"event_export","job_parameters":{"job_parameters":{"query":{"criteria":{},"exclusions":{},"query":"*:*","time_range":{"start":"2023-03-26T02:00:00.000Z","end":"2023-03-29T02:06:20.864Z"},"rows":10000,"fields":["*"],"sort":[{"field":"device_timestamp","order":"DESC"}]}},"process_guid":null,"api_resource":"PROCESS_EVENTS","version":"v2","search_id":null},"connector_id":"12345ABCD","org_key":"ABCD1234","status":"CREATED","create_time":"2023-03-29T16:20:59.013Z","last_update_time":"2023-03-29T16:20:59.014Z"}