API Reference

Get all event challenge details

This API is used to get all event challenge details from the specified event. It will return data like eventChallengeId, action, area, description, startDate, endDate, rewards, trigger, ticketTypeAllowInChallenge etc.

To call this API, the user has to pass query param with API URL like eventUrl and authentication key to authenticate the user.

Response

Here is the description of response attributes, which returns to the form of JSON.

AttributeDescription
eventChallengeId The Id returns a unique value associated with the event challenge.
action This will return the list of action challenges.
area This contains the area of the challenge.
description This contains a description of the challenge. Only 65535 Characters are allowed
endDate This contains the challenge end date in yyyy/MM/dd HH:mm format.
endDateUtc This will return the UTC format end date.
filter This will return the list of filter challenges.
gamificationTabDisabled This contains the gamification tab enabled in the virtual event hub.
goal This will return the challenge goal points.
maxPoints This will return the list of maximum point configurations.
name This contains the name of the event challenge details.
rewards This will return the list of rewards event challenges.
startDate This contains the challenge start date in yyyy/MM/dd HH:mm format.
startDateUtc This will return the UTC format start date.
subArea This will return the sub-area of event challenge details.
ticketTypeAllowInChallenge This will return the list of ticket types allowed in the challenge.
trigger This contains the trigger of the challenge.
type This will return the type of challenges like STANDARD, EARLY_BIRD, SCAVENGER_HUNT.

Error Code

Here are the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error CodeError Description
400The request could not be understood by the server due to malformed syntax.
401You are not authorized to view the resource.
403Accessing the resource you were trying to reach is forbidden.
404The resource you were trying to reach is not found.
40600013Can't create url
4040200No Event could be found
Language
Credentials
Header
Click Try It! to start a request and see the response here!