Platform API Reports

Overview

Talroo's Platform API supports the ability to optionally include supplemental data in what we call "reports" for GET calls on certain objects. These reports are meant to provide additional data from related objects without the need for additional API calls.

Reports are pulled via the report query parameter.

Below are the different objects whose GET calls support Reports, and a list of the supported Reports with their description.

Job Campaigns

The structure of the below reports can be seen in the object response schema for the GET /campaigns/{campaign} endpoint.

• SPENDING: Returns spend accrued yesterday (EST)
• SCHEDULING: Returns all active and future Scheduled Objects i.e. One Time Budgets, Monthly Budget Changes, and Pauses
• JOBS: Returns a count of the jobs assigned to this Job Campaign
• EVENTS: Event Job Campaigns Only - Returns RSVP counts for today and for the entire Event
• POOL: Returns information about the Job Campaign's parent Job Pool