Participants Game performance

Description

Get details about the users that participated in the activation.
This call will return all game related metrics.

Widget List

Get the list of widgets that game performance data is relevant for them.
By default the endpoint returns only game widgets.

Request

CODE

https://api.picogp.com/v1/activation/<ACTIVATION_ID>/widgets

Method: GET

Optional parameters:

Game_only
- default value: false
- If true will return all types of widgets

Response

JSON

{
	"data": [
		{
			"id": "1635320259340",
			"is_first": true,
			"is_last": false,
			"title": "Trivia",
			"description": "",
			"active": true,
			"type": "TriviaGame",
			"created_time": 1635320181,
			"broadcast_active": false,
			"valid_platforms": [
				"Facebook",
				"PicoMessenger",
				"Twitter"
			],
			"position": {
				"top": 25,
				"left": 25
			},
			"measurement": false,
			"activation_id": 2448,
			"campaign_id": 124,
			"participants": 0,
			"participants_percent": 0,
			"campaign_name": "",
			"activation_name": "",
			"is_broadcast_available": false,
			"is_game": true
		}
	]
}

Game Performance Data

Description

All users that participated in an activation.

Each user object includes:

Labels set on the user.
The user’s selections in the activation (for example in the below response the multiple values a user has selected in Trivia Game.

Request

CODE

https://api.picogp.com/v1/bot/<WIDGET_ID>/users?order_by=name&order_dir=asc&limit=50&offset=0

Method: GET

Headers: Auth

Parameters

WIDGET_ID: The ID of the bot set as retrieved in Widget List
limit: the number of records to return (min: 1 | max 50 | default 10).
offset: pagination parameter 0 to n.
order_dir: ASC | DESC 0 - Default: ASC

Response

JSON

{
	"data": {
		"total": 1,
		"to_send": 0,
		"users": [
			{
				"id": "1637181592208",
				"user": {
					"id": "b28685637072c074f2b4a04aaef1eee3cfd0d2d90b53be389154e53e1451d7ab",
					"name": "",
					"username": "",
					"profile_picture": "../../../../assets/imgs/messages/blank-profile-picture.png",
					"campaigns": [],
					"content": [],
					"user_type": "pm",
					"locale": "en-US",
					"timezone": -2,
					"labels": [
						{
							"id": "809",
							"value": "2021-11-17 20:37:45",
							"is_dashboard_metric": false,
							"dashboard_sort_index": -1,
							"additional_labels": []
						},
						{
							"id": "751",
							"value": "en-US",
							"is_dashboard_metric": false,
							"dashboard_sort_index": -1,
							"additional_labels": []
						},
						{
							"id": "736",
							"value": "b28685637072c074f2b4a04aaef1eee3cfd0d2d90b53be389154e53e1451d7ab",
							"is_dashboard_metric": false,
							"dashboard_sort_index": -1,
							"additional_labels": []
						}
					],
					"user_hash_id": "b28685637072c074f2b4a04aaef1eee3cfd0d2d90b53be389154e53e1451d7ab",
					"profile_picture_extension": ""
				},
				"date_added": 1637181492000,
				"date_updated": 1637181511000,
				"start_time": 1637181486287,
				"questions_info": [],
				"items": [
					{
						"question_id": 1635320236872,
						"question_title": "Question 1",
						"answers": [
							{
								"title": "answer 1",
								"isCorrect": null,
								"id": "1635320193152"
							},
							{
								"title": "answer 2",
								"isCorrect": null,
								"id": "1635842379074"
							}
						],
						"start_time": 1637181495465,
						"finish_time": 1637181506922,
						"is_correct": true
					}
				],
				"total_correct_answers": 1
			}
		]
	}
}