Get Challenge Details by Event Challenge ID

This API is used to get challenge details using the event challenge ID associated with the specified event.

This API is used on the host side. Event admins and super admins can access it.

It will return data like area, name, description, startDate, endDate, action, startDateUtc, endDateUtc, eventChallengeId, gamificationTabDisabled and other details.

To call this API, users have to pass query parameters with API URL like eventChallengeDetailId and authentication key to authenticate user.

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

Attribute

Description

area

It's conatins the area of the challlenge. It will return area like Expo, Sessions, Networking and Event.

eventChallengeId

It's contains the event challenge Id.

name

It's contains the challenge name. Only 255 Characters are allowed

description

It's contains the challenge description. Only 65535 Characters are allowed

startDate

Returns the challenge start date in yyyy/MM/dd HH:mm format.

endDate

Returns the challenge end date in yyyy/MM/dd HH:mm format

action

Returns the action taken by the user in the challenge.
Examples:

  • If your area is Expo then it will return an action like Visit, Chat, Watch, Link Click, Document Download, Request Meeting or All.
  • If your area is Sessions then it will return an action like Watch, Visit or All.
  • If your area is Networking then it will return an action like Matches, Connections or All.

trigger

Returns the trigger of the challenge.
Examples:

  • If your area is Expo then it will return a trigger like exhibitor and category or All.
  • If your area is Sessions then it will return a trigger like main_stage, breakout_session, workshop or All.
  • If your area is Networking then it will return a trigger like Networking or All.

goal

Returns the challenge goal points.

rewards

Returns the challenge rewards.

ticketTypeAllowInChallenge

Returns the ticket types allowed to participate in the challenge. It will return list of ticket type IDs.

gamificationTabDisabled

Returns the gamification tab enabled or disabled in virtual event hub.

startDateUtc

Returns the start date UTC format.

endDateUtc

Returns the end date UTC format.

type

Returns the challenge type. It will return either STANDARD, EARLY_BIRD, SCAVENGER_HUNT.

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

Error code

Error Description

400

The request could not be understood by the server due to malformed syntax.

401

You are not authorized to view the resource.

403

Accessing the resource you were trying to reach is forbidden.

404

The resource you were trying to reach is not found.

Language
Authentication
Header
Click Try It! to start a request and see the response here!