REST API

Updated on Thursday, 13 February, 2014 - 12:01

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.

Core
Resource Purpose
validate

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

compile

Compile a CSDL filter.

stream

Run a compiled 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.

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.

Historics
Resource Purpose
historics/prepare

Create a new Historics query and return its id.

historics/start

Start an existing Historics query.

historics/stop

Stop an existing Historics query.

historics/status

Check data coverage in the archive for a specified interval.

historics/update

Update the name of an existing Historics query.

historics/delete

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

historics/get

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

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/update

Update a Managed Source.

source/delete

Delete a Managed Source.

source/get

Get a Managed Source.

source/log

Get the log for a specific Managed Source

source/stop

Stop delivery of source data.

source/start

Start/restart delivery of source data.