API documentation

GET /api/v1/datasets
Get datasets

Supported Formats

json

Params

Param name	Description Validations
from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
rollup_period Optional	The interval. Validations: Must be a decimal number.
rollup_aggregator Optional	The function to apply to the result set. Validations: Must be one of: `sum`, `min`, `max`, `avg`.
buyer_id Optional	Refer to the buyer api for details Validations: Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
offer_id Optional	Refer to the offer api for details Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
traffic_source_id Optional	Refer to the traffic source api for details Validations: Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
queries Optional	Translation missing: en.api.datasets.queries Validations: Must be a a valid array of queries.
series_calc_function Optional	Translation missing: en.api.datasets.series_calc_function Validations: Must be one of: `timeseries`, `sum`, `avg`, `min`, `max`.
html_links Optional	Translation missing: en.api.datasets.html_links Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/datasets/calls/:stat
Get call datasets

Supported Formats

json

Params

Param name	Description Validations
stat Required	Return statistics on the grouped calls by one of these numeric columns. Validations: Must be one of: `buyer_converted_count`, `offer_converted_count`.
data_format Optional	Translation missing: en.api.data_format Validations: Must be one of: `timeseries`, `sum`.
interval Optional	A timeframe Validations: Must be one of: `300`, `600`, `1200`, `3600`, `86400`, `2629746`.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String

GET /api/v1/datasets/leads/:stat
Get call datasets

Supported Formats

json

Params

Param name	Description Validations
stat Required	Translation missing: en.api.leads.stat Validations: Must be one of: `has_next_action_count`, `buyer_converted_count`, `offer_converted_count`.
data_format Optional	Translation missing: en.api.data_format Validations: Must be one of: `timeseries`, `sum`.
interval Optional	A timeframe Validations: Must be one of: `300`, `600`, `1200`, `3600`, `86400`, `2629746`.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String

GET /api/v1/datasets/billing
Get the billing dataset

Supported Formats

json

Params

Param name	Description Validations
data_format Optional	Translation missing: en.api.data_format Validations: Must be one of: `timeseries`, `sum`.
interval Optional	A timeframe Validations: Must be one of: `300`, `600`, `1200`, `3600`, `86400`, `2629746`.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String

GET /api/v1/datasets/number_impressions
Get the number impression dataset

Supported Formats

json

Params

Param name	Description Validations
data_format Optional	Translation missing: en.api.data_format Validations: Must be one of: `timeseries`, `sum`.
interval Optional	A timeframe Validations: Must be one of: `300`, `600`, `1200`, `3600`, `86400`, `2629746`.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String