Check status of service
Retrieve the status of the service. Use to check that api key authentication is working.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.x-request-idstring · uuidUnique request id for tracing purposes that can be provided in the header of any request
Responses
OK
Create batch ingestion job
Creates a batch ingestion job
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
OK
idstring · uuiduuid for a batch job
itemsobject[]item_countnumbertotal items in batch
Example: 100success_countnumberitems successfully processed
Example: 99error_countnumberitems with errors in processing
Example: 1
Get batch job status
Get the status of a batch job and items in the batch
path Parameters
batch_job_idstring · uuid · requiredID of the batch job returned when the batch was submitted
Example: 497f6eca-6276-4993-bfeb-53cbbbba6f08
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
OK
idstring · uuiduuid for a batch job
itemsobject[]item_countnumbertotal items in batch
Example: 100success_countnumberitems successfully processed
Example: 99error_countnumberitems with errors in processing
Example: 1
Retrieve batches
Retrieve multiple batch job results, using a tag and a date/time
query Parameters
tagstring · requiredtag matching the submitted batch job
Example: test1updated_sincestring · date-time · requiredreturn batches updated since the specified date/time (ISO-8601)
Example: 2022-09-05T20:32:59+0000
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
OK
resultsobject[]