Account

APIDescription
GET account/configuration/{accountId}

Get the current configuration for the account

GET {publisherId}/configuration

Get the current configuration for the account

GET account/configuration/{accountId}/tracking/{publisherId}

Get the tracking script for the publisher

POST {publisherId}/rebuild

Rebuild the account from raw tracking data

PUT account/configuration/{accountId}

Update some part of the account configuration

PUT {publisherId}/configuration

Update some part of the publisher configuration

Configuration

APIDescription
GET system/configuration/{accountId}

Get the current configuration for the account

POST system/configuration/{accountId}

Set the initial configuration for an account

PUT system/configuration/{accountId}

Update some part of the account configuration

Contact

APIDescription
PUT {publisherId}/contacts/{engageId}/bind?trackingId={trackingId}

Bind a tracking id to an Engage Id

POST {publisherId}/contacts/bind

Bind a set of tracking ids to their Engage Ids

DELETE {publisherId}/contacts/remove

Unbind a set of Engage Ids from their tracking events, reverting the events back to anonymous

GET {publisherId}/{type}/summary

Get the contact summary for a publisher

Counters

APIDescription
GET performance/counters/{counterType}/{counterName}?sampleCount={sampleCount}

Get counter performance data

Credentials

APIDescription
PUT system/credentials/{publisherId}

Reset the OAUTH credentials for a publisher

DELETE system/credentials/{publisherId}

Disable the OAUTH credentials for a publisher

EngageData

APIDescription
GET publications?maxRowCount={maxRowCount}

No documentation available.

Goal

APIDescription
GET {publisherId}/goals

Get the goals configured for an account

POST {publisherId}/goals/rebuild

Rebuild goal for an account

GET {publisherId}/goals/{goalId}

Get information for a specific goal

DELETE {publisherId}/goals/{goalId}

Delete a goal for an account

POST {publisherId}/goals/{goalId}

Create a new goal for an account

PUT {publisherId}/goals/{goalId}

Update the definition of an existing goal

GoalData

APIDescription
GET {publisherId}/goals/data/meta

Get the meta data for completed goals for this publisher

GET {publisherId}/goals/{goalId}/data

Get the completed goals for an account between a date range

GET {publisherId}/goals/{goalId}/data?version={version}

Get the completed goals for an account between a date range

GoalStatistics

APIDescription
GET {publisherId}/goals/{goalId}/stats/anonymous

Get the completed goal statistics for an account

GET {publisherId}/goals/stats/anonymous

Get the completed goal statistics for an account

GoalSummary

APIDescription
GET {publisherId}/goals/summary/data

Get the completed goals for an account between a date range

GET {publisherId}/goals/summary/data?fromUtc={fromUtc}&toUtc={toUtc}

Get the completed goals for an account between a date range

Index

APIDescription
GET {publisherId}/indexes

Get a list of indexes by publisher

GET {publisherId}/indexes/{name}/keys

Get a list of keys in an index

GET {publisherId}/indexes/{name}/keys?fromUtc={fromUtc}&toUtc={toUtc}

Get a list of keys in an index

GET {publisherId}/indexes/{name}?Query={Query}&Operation={Operation}&FromDateUtc={FromDateUtc}&ToDateUtc={ToDateUtc}

Get the contents of an index by name

PUT {publisherId}/indexes

Build index

DELETE {publisherId}/indexes/{name}

Drop index

IndexStatistics

APIDescription
GET {publisherId}/indexes/{name}/stats

Get a list of keys in an index

GET {publisherId}/indexes/{name}/stats?fromUtc={fromUtc}&toUtc={toUtc}

Get a list of keys in an index

Queue

APIDescription
GET queue/{name}/count

No documentation available.

POST queue/{name}/requeue

No documentation available.

ReportData

APIDescription
GET {publisherId}/reports/{reportRequestId}/data

Get data from a report that has been completed

ReportRequest

APIDescription
POST {publisherId}/reports/{reportRequestId}

Schedule a task for getting data from a report

DELETE {publisherId}/reports/{reportRequestId}

Cancel the pending task for getting data from a report and delete associated data

GET {publisherId}/reports/{reportRequestId}

Get the status of an ongoing report request

SqlTemplate

APIDescription
POST system/sql/template/{location}/{name}

No documentation available.

PUT system/sql/template/{location}/{name}/execute/{publisherId}

No documentation available.

PUT system/sql/template/{location}/{name}/execute?timeOutSeconds={timeOutSeconds}

No documentation available.

SqlUser

APIDescription
PUT system/sql/user/{publisherId}/create

No documentation available.

System

APIDescription
POST test/error

No documentation available.

POST test/ping

No documentation available.

TrackingData

APIDescription
GET {publisherId}/data

Get the tracking data for a publisher since tracking began

GET {publisherId}/data?fromUtc={fromUtc}&toUtc={toUtc}

Get the tracking data for a publisher between a date range

TrackingRawData

APIDescription
GET {publisherId}/data/raw

Get the raw tracking data (no filters applied) for a publisher since tracking began

GET {publisherId}/data/raw?fromUtc={fromUtc}&toUtc={toUtc}

Get the raw tracking data (no filters applied) for a publisher between a date range

TrackingSummary

APIDescription
GET {publisherId}/data/summary

Get the tracking data for a publisher since tracking began

GET {publisherId}/data/summary?fromUtc={fromUtc}&toUtc={toUtc}

Get the tracking statistics for a publisher between a date range

DELETE {publisherId}/data/summary

Reset the tracking summary for a publisher