Panel

The panel API allows you to retrieve and update your panelists. Below are some common operations you can perform on the panel.

• Bulk update panelists

• Export the entire panel

• Search panelists

• Retrieve a single panelist by ID

Adding or Updating Panelists

Panelist data is provided as a set of key-value pairs, with the key being the column's ID in the schema.

Values types vary depending on the column type in the schema. Possible value types are:

• Strings (for most columns)

• String arrays (for multiple choice answers)

• Numbers (for numeric columns)

• Boolean (for boolean columns)

The following built-in columns also have a first-class presence on the panelist object. This data is also replicated within the Data object.

When adding or updating a panelist, the Location parameter on the panelist expects a Country and a PostalCode. No other parameter is editable on Location, namely Province or City, as these are automatically populated from the PostalCode if they can be resolved.

The platform will ignore any attempt to set the values of the following built-in Data properties: q_name, q_lastname, q_email, q_phone, q_dob. Instead, the values specified in the root object (such as FirstName) will be replicated to the built-in Data properties automatically.

You must specify a valid Country in the Location property. You may only specify countries that have been enabled for your tenant.

Every panelist must have a valid Email specified. Duplicate panelists with the same Email is not permitted.

Exporting the Panel

Making a call to the export panel endpoint will begin an export job. Once you have received the identifier of an export request, retrieve the latest status of the export by successively polling for updates. It may take several minutes for an export task to complete, depending on the size your panel and the number of records included in your export based on your specified filters.

Once an export is in the complete status, you will be able to obtain the Url from which you can download the export artifact. URLs are valid for approximately 30 minutes after retrieving the export. If a URL expires, you will need to retrieve the export a subsequent time to receive a fresh URL.

For security, data protection and privacy purposes, export artifacts are encrypted with the Key. When opening the ZIP artifact, you will be prompted for this password to access the export.

Export Expiry

All completed exports (including failed requests) expire and will be deleted within approximately 24 hours of the Completed time. Please ensure you download all export artifacts as soon as possible to avoid unexpected data loss.

Deleting Panelists

A panelist may only be deleted if all of the following are true:

• No respondent record is attached to the panelist

• No incentives have been issued to the panelist

If a panelist does not meet the deletion criteria, the API will return a 403 Forbidden response.