REST API Endpoints

Here's the complete list of REST API endpoints. Make sure you read the API Authentication page too. You can try any of these endpoints in our Developer Console. Take a look at our summary of the HTTP response codes from each endpoint. We also have a handy guide to endpoint dependencies.

Core
Resource Purpose
validate

Check the syntax of the CSDL code of a filter without compiling.

compile

Compile a CSDL filter.

usage

Check the number of objects processed and delivered for a given time period.

dpu

Calculate the DPU cost of consuming a stream.

balance

Determine your credit balance or DPU balance.

Historics
Resource Purpose
historics/prepare

Create a new Historics query and return its id.

historics/start

Start an existing Historics query.

historics/pause

Pause an existing Historics query.

historics/resume

Resume a paused Historics query.

historics/update

Update the name of an existing Historics query.

historics/status

Check data coverage in the archive for a specified interval.

historics/get

Retrieve details and status codes for one or more Historics queries for a specified user.

historics/stop

Stop an existing Historics query.

historics/delete

Delete one specified Historics query. If the query is currently running, stop it.

Historics Preview
Resource Purpose
preview/create

Create a preview of a Historics query.

preview/get

Retrieve a Historics preview.

Managed Sources
Resource Purpose
source/create

Create a Managed Source.

source/start

Start or restart delivery of source data.

source/stop

Stop delivery of source data.

source/delete

Delete a Managed Source.

source/get

Retrieve details of a Managed Source.

source/update

Update a Managed Source.

source/auth/add

Add one or more authorization credentials to a Managed Source.

source/auth/remove

Remove one or more authorization tokens from a Managed Source.

source/resource/add

Add one or more resources to a Managed Source.

source/resource/remove

Remove one or more resources from a Managed Source.

source/log

Retrieve the log for a specific Managed Source.

Push
Resource Purpose
push/validate

Check that a Subscription is defined correctly.

push/create

Create a new Subscription to a live stream or Historics query.

push/pause

Pause a Subscription and buffer the data for up to one hour.

push/resume

Set a paused job running again.

push/update

Update the name or output parameters for an existing Subscription.

push/stop

Stop a Historics query or a live stream that is running with Push.

push/delete

Delete an existing Subscription.

push/log

Retrieve details of your Push subscriptions.

push/get

Show details of the Subscriptions belonging to this user.

pull

Collect a batch of interactions from a Push queue.