REST API Endpoints

Here's the complete list of REST API endpoints. Make sure you read the API Authentication page too.

Take a look at our summary of the HTTP response codes from each endpoint.

Pylon For Facebook Topic Data
Resource Purpose
pylon/get

Retrieve details of one or all of your interaction filters.

pylon/compile

Compile an interaction filter.

pylon/validate

Check the syntax of the CSDL code of an interaction filter without compiling.

pylon/start

Start recording an interaction filter to your index. Or restart a recording that has stopped.

pylon/stop

Stop recording an interaction filter to your index.

pylon/update

NEW!!! Update the CSDL code of a recording while it is running or rename a recording.

pylon/analyze

Analyze a recording and provide results in the form of frequency distribution or time series data.

pylon/sample

Sample up to 100 interactions per hour per recording from the Super Public feed.

pylon/tags

Retrieve the namespaces of tags that have been applied to interactions stored in an index.

Account Api
Resource Purpose
GET /account/identity

Retrieve account identities.

POST /account/identity

Create a new identity.

GET /account/identity/{id}

Retrieve details of a specified account identity.

PUT /account/identity/{id}

Update the details of an existing identity.

GET /account/identity/limit/{service}

Retrieve the identity limits set for a given service.

GET /account/identity/{identity_id}/token

List all the tokens for a given Identity.

POST /account/identity/{identity_id}/limit

Set new service limits for an identity.

POST /account/identity/{identity_id}/token

Assign a token for a service to an identity.

GET /account/identity/{identity_id}/limit/{service}

Retrieve the service limits set for an identity.

PUT /account/identity/{identity_id}/limit/{service}

Update service limits set for an identity.

GET /account/identity/{identity_id}/token/{service}

Retrieve the token for a given Identity for a given service.

PUT /account/identity/{identity_id}/token/{service}

Update the assigned token, or assign a new token for a service to an identity.

DELETE /account/identity/{identity_id}/limit/{service}

Delete service limits set for an identity.

DELETE /account/identity/{identity_id}/token/{service}

Delete a token for a particular service.

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.

Push
Resource Purpose
push/get

Show details of the Subscriptions belonging to this user.

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.

pull

Collect a batch of interactions from a Push queue.

Managed Sources
Resource Purpose
source/get

Retrieve details of a Managed Source.

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

Update a Managed Source.

source/log

Retrieve the log for a specific 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.

Historics
Resource Purpose
historics/get

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

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

Pause an existing Historics query.

historics/resume

Resume a paused Historics query.

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

Check data coverage in the archive for a specified interval.

Historics Preview
Resource Purpose
preview/get

Retrieve a Historics preview.

preview/create

Create a preview of a Historics query.