Business Third Party Partner Panel Requests

Optional filter on the request country.

From a valid ISO2 country codes (2-letter).

Can enter a single country or an array of countries. The array filter is a set contains, e.g. if a business has a request with country 'US', a request with country 'GB', and has filter country=['US', 'GB'], then both requests will be returned.

Valid input examples:

Invalid input examples:

Optional filter on the request description.

This is a case-insensitive, substring search on the field.

Ex: Suppose we have 3 requests with descriptions of:

Then both of the following filters will return all 3 requests:

Optional filter on the request end time (unix-timestamp).

For comparisons (comp => function):

end_time={'comp': [comp], 'ts': [ts]}

Ex: end_time={'comp': 'GEQ', 'ts': 1684972800} which is end_time <= 1684972800

For comp 'BW' => 'between'

end_time={'comp': 'BW', 'ts': [ts], 'ts2': [ts2]}

Ex: end_time={'comp': 'BW', 'ts': 1684972800, 'ts2': 1685145599} which is 1684972800 <= end_time <= 1685145599

Optional filter on the request owner instance ID.

From a valid instance ID.

Can enter a single instance ID or an array of instance ID. The array filter is a set contains, e.g. if a business has a request with instance ID 1234, a request with instance ID 5678, and has filter owner_instance_id =[1234, 5678], then both requests will be returned.

Valid input examples:

Invalid input examples:

Optional filter on the request owner panel ID.

From a valid panel ID.

Can enter a single panel ID or an array of panel ID. The array filter is a set contains, e.g. if a business has a request with panel ID 4321, a request with panel ID 8765, and has filter owner_panel_id =[4321, 8765], then both requests will be returned.

If this filter is used in conjunction with owner_panel_name, it will filter out panels based on the union of the owner_panel_id's and owner_panel_name's, e.g. for a panel (id, name), if a business has a request with panel (4321, 'alpha') and a request with panel (8765, 'omega'), and has filters owner_panel_id=4321 and owner_panel_name='omega', then both requests will be returned.

Valid input examples:

Invalid input examples:

Optional filter on the request owner panel name.

This is a case-insensitive, substring search on the field.

Ex: Suppose we have 3 panels with descriptions of:

Then the following filters will both return all 3 requests:

Can enter a single panel name or an array of panel names. The array filter is a set contains,, e.g. if a business has a request with panel name 'alpha', a request with panel name 'omega', and has filter owner_panel_name =['alpha', 'omega'], then both requests will be returned.

If this filter is used in conjunction with owner_panel_name, it will filter out panels based on the union of the owner_panel_id's and owner_panel_name's, e.g. for a panel (id, name), if a business has a request with panel (4321, 'alpha') and a request with panel (8765, 'omega'), and has filters owner_panel_id=4321 and owner_panel_name='omega', then both requests will be returned.

Valid input examples:

Invalid input examples:

Optional filter on the request start time (unix-timestamp).

For comparisons (comp => function):

start_time={'comp': [comp], 'ts': [ts]}

Ex: start_time={'comp': 'GEQ', 'ts': 1684972800} which is start_time <= 1684972800

For comp 'BW' => 'between'

start_time={'comp': 'BW', 'ts': [ts], 'ts2': [ts2]}

Ex: start_time={'comp': 'BW', 'ts': 1684972800, 'ts2': 1685145599} which is 1684972800 <= start_time <= 1685145599

Optional filter on the request status.

From the set { CREATED, FAILURE, IN_PROGRESS, SCHEDULED, SUCCESS }

Can enter a single study type or an array of statuses. The array filter is a set contains, e.g. if a business has a request with 'CREATED', a request with 'SUCCESS', and has filter status=['CREATED', 'SUCCESS'], then both requests will be returned.

Valid input examples:

Invalid input examples:

Optional filter on the request study type.

From the set { BRAND_LIFT, PANEL_SALES_ATTRIBUTION, REACH }

Can enter a single study type or an array of study types. The array filter is a set contains, e.g. if a business has a request with study type 'BRAND_LIFT', a request with study type 'REACH', and has filter study_type=['BRAND_LIFT', 'REACH'], then both requests will be returned.

Valid input examples:

Invalid input examples:

Optional filter on the request submission time (unix-timestamp).

For comparisons (comp => function):

submitted_time={'comp': [comp], 'ts': [ts]}

Ex: submitted_time={'comp': 'GEQ', 'ts': 1684972800} which is submitted_time <= 1684972800

For comp 'b/w' => 'between'

submitted_time={'comp': 'BW', 'ts': [ts], 'ts2': [ts2]}

Ex: submitted_time={'comp': 'BW', 'ts': 1684972800, 'ts2': 1685145599} which is 1684972800 <= submitted_time <= 1685145599

200

Permissions error