Info Value
Updated on 11 July 2019
Response format JSON
HTTP Methods GET
Response object Event
API Version 1.0

Event/Get

Retrieve a specific event for a game.

Parameters

Parameter Type Description
event_id
string The ID of the event being requested
include_deleted
(optional)
integer Include events which have been marked as deleted
user_id
(optional)
integer When set the method will only return events for which this user is registered or there are no criteria

Response

Element Type Description
event_id integer The ID of the event
game_id integer The game ID of the event
start_datetime string The date/time in UTC of when this event started
end_datetime string The date/time in UTC of when this event will finish
event_name string The event name
event_description string The event description
share_text string The text to use when the event is shared on social media
created_datetime string The date/time in UTC of when this event was created
updated_datetime string The date/time in UTC of when this event was last updated
event_status_id integer The ID of the event's status
event_status_dscr string The description of the event's status
deleted boolean Whether the event is marked as deleted
criteria array An array of applicable criteria for the event
Indexed by event criteria id with key in the format event_criteria_##
See Criteria Object
frequency string The frequency string used to calculate how often the event repeats
frequency_end_datetime string The date/time in UTC of when this event will finish repeating
parent_event_id integer The ID of the parent event (if this is an instance of a repeating event)
original_start_datetime string The date/time in UTC of when this event originally started (if this is an instance of a repeating event)
levels array An array of applicable levels for the event
Indexed by level number with key in the format level_##
See Level Object

Criteria Object

Element Type Description
event_criteria_id integer The ID of the criteria
event_id integer The ID of the parent event
entry_cost integer The cost of entering the event
entry_currency_id integer The ID of the currency paid to enter the event
entry_currency_name string The name of the currency paid to enter the event
country_id integer The ID of the country allowed to enter the event (0 for all countries)
platform_id integer The ID of the platform allowed to enter the event (0 for all platforms)
rank integer The minimum rank required to enter the event
level integer The minimum level required to enter the event
created_datetime string The date/time in UTC of when this set of criteria was created
updated_datetime string The date/time in UTC of when this set of criteria was last updated
deleted boolean Whether the set of criteria is marked as deleted

Level Object

Element Type Description
event_id integer The ID of the parent event
level integer The number of the level
leaderboard_id integer The ID of the leaderboard

Example

Request

https://api.miniclip.com/json/?app_id=##&secret=##&signature=##&method=Event/Get&event_id=##

https://api.miniclip.com/json/?app_id=##&secret=##&signature=##&method=Event/Get&event_id=##&include_deleted=##

https://api.miniclip.com/json/?app_id=##&secret=##&signature=##&method=Event/Get&event_id=##&user_id=##

Sample response

{
	"event_id" : 123,
	"game_id" : 1234,
	"start_datetime" : "2014-10-13 07:00:00",
	"end_datetime" : "2014-10-13 15:00:00",
	"event_name" : "Test Event,
	"event_description" : "A test event",
	"share_text" : "Test sharing text",
	"created_datetime" : "2014-10-13 06:00:00",
	"updated_datetime" : "2014-10-13 06:00:00",
	"event_status_id" : 1,
	"event_status_dscr" : "Enabled",
	"deleted" : false,
	"criteria" : {
		"event_criteria_123" : {
			"event_criteria_id" : 123,
			"event_id" : 123,
			"entry_cost" : 20,
			"entry_currency_id" : 2,
			"entry_currency_name" : "Miniclip Credits",
			"country_id" : 0,
			"platform_id" : 0,
			"rank" : 5,
			"level" : 10,
			"created_datetime" : "2014-10-13 06:00:00",
			"updated_datetime" : "2014-10-13 06:00:00",
			"deleted" : false
		}
	},
	"frequency" : null,
	"frequency_end_datetime" : null,
	"parent_event_id" : null,
	"levels" : {
		"level_10" : {
			"event_id" : 123,
			"level" : 10,
			"leaderboard_id" : 123
		}
	}
}