Skip to main content

API Endpoints

Below is a list of endpoints currently available along with a brief description of the metrics returned.

Partner Earnings

Returns a report of USD earnings for a partner account, grouped by Day and ClientId.

GET https://api.inbrain.ai/api/v2/reports/earnings

Average Revenue Per Daily Active User

Returns a report of average USD earnings per panelist per day, grouped by Day and ClientId.

GET https://api.inbrain.ai/api/v2/reports/avg-revenue-per-panelist

Survey Starts

Returns a report of Survey Starts, grouped by Day and ClientId. A Survey Start is defined by the action of a panelist entering a survey.

GET https://api.inbrain.ai/api/v2/reports/survey-starts

Survey Payouts

Returns a report of Survey Payouts, grouped by Day and ClientId. A Survey Payout is defined by any event where a panelist is paid and revenue is generated by inBrain to the Partner.

GET https://api.inbrain.ai/api/v2/reports/payouts

Active Panelists

Returns a report of active panelist, grouped by Day and ClientId. An active panelist is defined by any panelist that attempts at least one survey on a given day.

GET https://api.inbrain.ai/api/v2/reports/active-panelist