Panelists

Register and update survey panelist information.

Register Panelist

Registers a panelist for proper targeting. This should only be done once per panelist. Update to panelist profiles can be done via Update Panelist.

Request URL	/register-user
Request Method	POST

Request Parameters

Parameter Name	Parameter Type	Required?	Description
apik	String	Yes	Key uniquely identifying the supplier
request_date	Numeric	Yes (in milliseconds)	See authentication
signature	String	Yes (see here)	Required to authenticate supplier call
vpid	String	Yes	The supplier’s static panelist ID. Allowed characters include: Uppercase A - Z, Lowercase a - z, 0-9, _, *, @, -, [ ], $.
country_id	Numeric	Yes	The countryID of panelist
source_name	String	No	Name of panelist source
profile	JSON Profile JSON sample [ { "question_id":3, "precodes": ["1"] }, { "question_id":1, "precodes": ["21"] }, { "question_id":24,"precodes": ["90245"] } ]	Yes	Panelist’s demographic data.

Response Parameters

Response Parameters
Parameter Name	Parameter Type	Description / Notes
return_status	String	The return status for this api call

Update Panelist

Update the information of an existing panelist.

Request URL	/update-user
Request Method	POST

Request Parameters

Parameter Name	Parameter Type	Required?	Description
apik	String	Yes	Key uniquely identifying the supplier
request_date	Numeric	Yes (in milliseconds)	See authentication
signature	String	Yes (see here)	Required to authenticate supplier call
vpid	String	Yes	Existing static panelist ID
country_id	Numeric	Yes	The updated countryID of the panelist
source_name	String	No	Updated name of the panelist source
profile	JSON Profile JSON sample [ { "question_id":3, "precodes": ["1"] }, { "question_id":1, "precodes": ["21"] }, { "question_id":24,"precodes": ["90245"] } ]	Yes	The panelist’s demographic data to update. All other demographic data will remain unchanged.

Response Parameters

Parameter Name	Parameter Type	Description / Notes
return_status	String	The return status for this api call