Recent Campaign Details

Authorizations

• Authorization string required header

Query Parameters

• campaign_id string

  The campaign ID to get details for.
  If not provided, the list of campaign details are returned.

• currency string

  Currency code Example: EUR

• exclude_fields string

  Comma-separated list of fields to exclude from the response. Useful when you want to reduce payload size by omitting specific fields. For example: game_ids,image,terms Example: game_ids,image,terms

• language string

  Two letters code of language according to ISO 639-1 standard Example: en

• player_id string

  Filter the list of campaigns to return just the ones that player
  is a part of the selection

• tenant_name string required

• anyOf options 3 variants anyOf

  One or more options can apply.

  + - Show Child Attributes

  • option 1 object

    + - Show Child Attributes

    • active[] object array

      + - Show Child Attributes

      • id integer

        Internal ID for use around the API

      • human_id string

        Campaign ID visible in the backoffice and the campaign reports

      • name string

        Localized campaign title

      • type allOf

        + - Show Child Attributes

        • allOf 1 string enum allOfenum

          An enumeration. Allowed values: jackpot, missions, prize drop, tournaments.

      • opt_in_method allOf

        + - Show Child Attributes

        • allOf 1 string enum allOfenum

          An enumeration. Allowed values: no_opt_in, opt_in_via_overlay, opt_in_via_api.

      • status allOf

        + - Show Child Attributes

        • allOf 1 string enum allOfenum

          An enumeration. Allowed values: active, scheduled, finished.

      • starts_at string (date-time)
      • ends_at string (date-time)
      • image string

        Localized campaign image URL (the same that is used in overlay)

      • tournament allOf

        If campaign is tournament this field will be populated with the details. Keep in mind that the content might change a bit depending on which tournament type is in play

        + - Show Child Attributes

        • type allOf allOf

          + - Show Child Attributes

          • allOf 1 string enum allOfenum

            An enumeration. Allowed values: point tournament, highest coin wins, tournament missions, individual missions, races.

        • leaderboard[] object allOfarray

          Tournament leaderboard sorted by a place, keeping in mind that the individual missions tournament score equals the number of spins to complete.

          + - Show Child Attributes

          • player_id string

            Schema traversal was truncated at maximum depth.

          • player_username string

            Schema traversal was truncated at maximum depth.

          • score string

            Schema traversal was truncated at maximum depth.

        • tournament_prizes[] anyOf allOfarray

          List of defined Tournament Prizes. Individual Missions Tournaments have different definitions based on number of spins instead of usual place.

          + - Show Child Attributes

          • anyOf options 2 variants anyOf

            One or more options can apply.

            + - Show Child Attributes

            • option 1 object

              Schema traversal was truncated at maximum depth.

            • option 2 object

              Schema traversal was truncated at maximum depth.

      • jackpots[] object array

        + - Show Child Attributes

        • id integer
        • campaign_id integer
        • title string
        • boosted_chance string
        • display_order integer
        • jackpot_type allOf

          + - Show Child Attributes

          • allOf 1 string enum allOfenum

            An enumeration. Allowed values: PB, PR, TD.

        • amount string

          Current jackpot amount responds to the currency passed in query string.

        • max_payout_amount string

          Amount responds to the currency passed in query string.

        • timespan allOf

          + - Show Child Attributes

          • id integer allOf

            Schema traversal was truncated at maximum depth.

          • day_of_month integer allOf

            Schema traversal was truncated at maximum depth.

          • day_of_week integer allOf

            Schema traversal was truncated at maximum depth.

          • interval string enum allOfenum

            An enumeration. Allowed values: EH, ED, EW. Schema traversal was truncated at maximum depth.

          • timespan_end string (date-time) allOf

            Schema traversal was truncated at maximum depth.

          • timespan_start string (date-time) allOf

            Schema traversal was truncated at maximum depth.

        • recent_wins[] object array

          Wins are ordered by recency

          + - Show Child Attributes

          • id integer

            Schema traversal was truncated at maximum depth.

          • payout string

            The field responds to the currency passed in query string. Schema traversal was truncated at maximum depth.

          • payout_date string (date-time)

            Schema traversal was truncated at maximum depth.

          • winner object

            Schema traversal was truncated at maximum depth.

        • payout_before string (date-time)

          When the current active jackpot must drop by

        • next_event_start string (date-time)

          When the next event will start if there's no active event

      • terms string

        Localized Terms and Conditions HTML that is displayed in the overlay. Currently available only for Tournaments due to technical limitations.

      • game_ids[] string array

        List of selected Game IDs, usually very long one.

      • hidden boolean

        Campaign is not visible in the overlay

    • scheduled_to_start_soon[] object array

      Up to 5 scheduled campaigns (ordered by start time)

      + - Show Child Attributes

      • id integer

        Internal ID for use around the API

      • human_id string

        Campaign ID visible in the backoffice and the campaign reports

      • name string

        Localized campaign title

      • type allOf

        + - Show Child Attributes

        • allOf 1 string enum allOfenum

          An enumeration. Allowed values: jackpot, missions, prize drop, tournaments.

      • opt_in_method allOf

        + - Show Child Attributes

        • allOf 1 string enum allOfenum

          An enumeration. Allowed values: no_opt_in, opt_in_via_overlay, opt_in_via_api.

      • status allOf

        + - Show Child Attributes

        • allOf 1 string enum allOfenum

          An enumeration. Allowed values: active, scheduled, finished.

      • starts_at string (date-time)
      • ends_at string (date-time)
      • image string

        Localized campaign image URL (the same that is used in overlay)

      • tournament allOf

        If campaign is tournament this field will be populated with the details. Keep in mind that the content might change a bit depending on which tournament type is in play

        + - Show Child Attributes

        • type allOf allOf

          + - Show Child Attributes

          • allOf 1 string enum allOfenum

            An enumeration. Allowed values: point tournament, highest coin wins, tournament missions, individual missions, races.

        • leaderboard[] object allOfarray

          Tournament leaderboard sorted by a place, keeping in mind that the individual missions tournament score equals the number of spins to complete.

          + - Show Child Attributes

          • player_id string

            Schema traversal was truncated at maximum depth.

          • player_username string

            Schema traversal was truncated at maximum depth.

          • score string

            Schema traversal was truncated at maximum depth.

        • tournament_prizes[] anyOf allOfarray

          List of defined Tournament Prizes. Individual Missions Tournaments have different definitions based on number of spins instead of usual place.

          + - Show Child Attributes

          • anyOf options 2 variants anyOf

            One or more options can apply.

            + - Show Child Attributes

            • option 1 object

              Schema traversal was truncated at maximum depth.

            • option 2 object

              Schema traversal was truncated at maximum depth.

      • jackpots[] object array

        + - Show Child Attributes

        • id integer
        • campaign_id integer
        • title string
        • boosted_chance string
        • display_order integer
        • jackpot_type allOf

          + - Show Child Attributes

          • allOf 1 string enum allOfenum

            An enumeration. Allowed values: PB, PR, TD.

        • amount string

          Current jackpot amount responds to the currency passed in query string.

        • max_payout_amount string

          Amount responds to the currency passed in query string.

        • timespan allOf

          + - Show Child Attributes

          • id integer allOf

            Schema traversal was truncated at maximum depth.

          • day_of_month integer allOf

            Schema traversal was truncated at maximum depth.

          • day_of_week integer allOf

            Schema traversal was truncated at maximum depth.

          • interval string enum allOfenum

            An enumeration. Allowed values: EH, ED, EW. Schema traversal was truncated at maximum depth.

          • timespan_end string (date-time) allOf

            Schema traversal was truncated at maximum depth.

          • timespan_start string (date-time) allOf

            Schema traversal was truncated at maximum depth.

        • recent_wins[] object array

          Wins are ordered by recency

          + - Show Child Attributes

          • id integer

            Schema traversal was truncated at maximum depth.

          • payout string

            The field responds to the currency passed in query string. Schema traversal was truncated at maximum depth.

          • payout_date string (date-time)

            Schema traversal was truncated at maximum depth.

          • winner object

            Schema traversal was truncated at maximum depth.

        • payout_before string (date-time)

          When the current active jackpot must drop by

        • next_event_start string (date-time)

          When the next event will start if there's no active event

      • terms string

        Localized Terms and Conditions HTML that is displayed in the overlay. Currently available only for Tournaments due to technical limitations.

      • game_ids[] string array

        List of selected Game IDs, usually very long one.

      • hidden boolean

        Campaign is not visible in the overlay

    • recently_finished[] object array

      Up to 5 finished campaigns (recently finished)

      + - Show Child Attributes

      • id integer

        Internal ID for use around the API

      • human_id string

        Campaign ID visible in the backoffice and the campaign reports

      • name string

        Localized campaign title

      • type allOf

        + - Show Child Attributes

        • allOf 1 string enum allOfenum

          An enumeration. Allowed values: jackpot, missions, prize drop, tournaments.

      • opt_in_method allOf

        + - Show Child Attributes

        • allOf 1 string enum allOfenum

          An enumeration. Allowed values: no_opt_in, opt_in_via_overlay, opt_in_via_api.

      • status allOf

        + - Show Child Attributes

        • allOf 1 string enum allOfenum

          An enumeration. Allowed values: active, scheduled, finished.

      • starts_at string (date-time)
      • ends_at string (date-time)
      • image string

        Localized campaign image URL (the same that is used in overlay)

      • tournament allOf

        If campaign is tournament this field will be populated with the details. Keep in mind that the content might change a bit depending on which tournament type is in play

        + - Show Child Attributes

        • type allOf allOf

          + - Show Child Attributes

          • allOf 1 string enum allOfenum

            An enumeration. Allowed values: point tournament, highest coin wins, tournament missions, individual missions, races.

        • leaderboard[] object allOfarray

          Tournament leaderboard sorted by a place, keeping in mind that the individual missions tournament score equals the number of spins to complete.

          + - Show Child Attributes

          • player_id string

            Schema traversal was truncated at maximum depth.

          • player_username string

            Schema traversal was truncated at maximum depth.

          • score string

            Schema traversal was truncated at maximum depth.

        • tournament_prizes[] anyOf allOfarray

          List of defined Tournament Prizes. Individual Missions Tournaments have different definitions based on number of spins instead of usual place.

          + - Show Child Attributes

          • anyOf options 2 variants anyOf

            One or more options can apply.

            + - Show Child Attributes

            • option 1 object

              Schema traversal was truncated at maximum depth.

            • option 2 object

              Schema traversal was truncated at maximum depth.

      • jackpots[] object array

        + - Show Child Attributes

        • id integer
        • campaign_id integer
        • title string
        • boosted_chance string
        • display_order integer
        • jackpot_type allOf

          + - Show Child Attributes

          • allOf 1 string enum allOfenum

            An enumeration. Allowed values: PB, PR, TD.

        • amount string

          Current jackpot amount responds to the currency passed in query string.

        • max_payout_amount string

          Amount responds to the currency passed in query string.

        • timespan allOf

          + - Show Child Attributes

          • id integer allOf

            Schema traversal was truncated at maximum depth.

          • day_of_month integer allOf

            Schema traversal was truncated at maximum depth.

          • day_of_week integer allOf

            Schema traversal was truncated at maximum depth.

          • interval string enum allOfenum

            An enumeration. Allowed values: EH, ED, EW. Schema traversal was truncated at maximum depth.

          • timespan_end string (date-time) allOf

            Schema traversal was truncated at maximum depth.

          • timespan_start string (date-time) allOf

            Schema traversal was truncated at maximum depth.

        • recent_wins[] object array

          Wins are ordered by recency

          + - Show Child Attributes

          • id integer

            Schema traversal was truncated at maximum depth.

          • payout string

            The field responds to the currency passed in query string. Schema traversal was truncated at maximum depth.

          • payout_date string (date-time)

            Schema traversal was truncated at maximum depth.

          • winner object

            Schema traversal was truncated at maximum depth.

        • payout_before string (date-time)

          When the current active jackpot must drop by

        • next_event_start string (date-time)

          When the next event will start if there's no active event

      • terms string

        Localized Terms and Conditions HTML that is displayed in the overlay. Currently available only for Tournaments due to technical limitations.

      • game_ids[] string array

        List of selected Game IDs, usually very long one.

      • hidden boolean

        Campaign is not visible in the overlay

  • option 2 object

    + - Show Child Attributes

    • id integer

      Internal ID for use around the API

    • human_id string

      Campaign ID visible in the backoffice and the campaign reports

    • name string

      Localized campaign title

    • type allOf

      + - Show Child Attributes

      • allOf 1 string enum allOfenum

        An enumeration. Allowed values: jackpot, missions, prize drop, tournaments.

    • opt_in_method allOf

      + - Show Child Attributes

      • allOf 1 string enum allOfenum

        An enumeration. Allowed values: no_opt_in, opt_in_via_overlay, opt_in_via_api.

    • status allOf

      + - Show Child Attributes

      • allOf 1 string enum allOfenum

        An enumeration. Allowed values: active, scheduled, finished.

    • starts_at string (date-time)
    • ends_at string (date-time)
    • image string

      Localized campaign image URL (the same that is used in overlay)

    • tournament allOf

      If campaign is tournament this field will be populated with the details. Keep in mind that the content might change a bit depending on which tournament type is in play

      + - Show Child Attributes

      • type allOf allOf

        + - Show Child Attributes

        • allOf 1 string enum allOfenum

          An enumeration. Allowed values: point tournament, highest coin wins, tournament missions, individual missions, races.

      • leaderboard[] object allOfarray

        Tournament leaderboard sorted by a place, keeping in mind that the individual missions tournament score equals the number of spins to complete.

        + - Show Child Attributes

        • player_id string

          Schema traversal was truncated at maximum depth.

        • player_username string

          Schema traversal was truncated at maximum depth.

        • score string

          Schema traversal was truncated at maximum depth.

      • tournament_prizes[] anyOf allOfarray

        List of defined Tournament Prizes. Individual Missions Tournaments have different definitions based on number of spins instead of usual place.

        + - Show Child Attributes

        • anyOf options 2 variants anyOf

          One or more options can apply.

          + - Show Child Attributes

          • option 1 object

            Schema traversal was truncated at maximum depth.

          • option 2 object

            Schema traversal was truncated at maximum depth.

    • jackpots[] object array

      + - Show Child Attributes

      • id integer
      • campaign_id integer
      • title string
      • boosted_chance string
      • display_order integer
      • jackpot_type allOf

        + - Show Child Attributes

        • allOf 1 string enum allOfenum

          An enumeration. Allowed values: PB, PR, TD.

      • amount string

        Current jackpot amount responds to the currency passed in query string.

      • max_payout_amount string

        Amount responds to the currency passed in query string.

      • timespan allOf

        + - Show Child Attributes

        • id integer allOf

          Schema traversal was truncated at maximum depth.

        • day_of_month integer allOf

          Schema traversal was truncated at maximum depth.

        • day_of_week integer allOf

          Schema traversal was truncated at maximum depth.

        • interval string enum allOfenum

          An enumeration. Allowed values: EH, ED, EW. Schema traversal was truncated at maximum depth.

        • timespan_end string (date-time) allOf

          Schema traversal was truncated at maximum depth.

        • timespan_start string (date-time) allOf

          Schema traversal was truncated at maximum depth.

      • recent_wins[] object array

        Wins are ordered by recency

        + - Show Child Attributes

        • id integer

          Schema traversal was truncated at maximum depth.

        • payout string

          The field responds to the currency passed in query string. Schema traversal was truncated at maximum depth.

        • payout_date string (date-time)

          Schema traversal was truncated at maximum depth.

        • winner object

          Schema traversal was truncated at maximum depth.

      • payout_before string (date-time)

        When the current active jackpot must drop by

      • next_event_start string (date-time)

        When the next event will start if there's no active event

    • terms string

      Localized Terms and Conditions HTML that is displayed in the overlay. Currently available only for Tournaments due to technical limitations.

    • game_ids[] string array

      List of selected Game IDs, usually very long one.

    • hidden boolean

      Campaign is not visible in the overlay

  • option 3 object

    + - Show Child Attributes

    • id string

      Internal ID for use around the API. It must start with S

    • human_id string

      Campaign ID visible in the backoffice and the campaign reports

    • name string

      Localized campaign title

    • type allOf

      + - Show Child Attributes

      • allOf 1 any enum allOfenum

        An enumeration. Allowed values: sportsbook missions.

    • opt_in_method allOf

      + - Show Child Attributes

      • allOf 1 string enum allOfenum

        An enumeration. Allowed values: no_opt_in, opt_in_via_overlay, opt_in_via_api.

    • status allOf

      + - Show Child Attributes

      • allOf 1 string enum allOfenum

        An enumeration. Allowed values: active, scheduled, finished.

    • starts_at string (date-time)
    • ends_at string (date-time)
    • image string

      Localized campaign image URL (the same that is used in overlay)

    • terms string

      Localized Terms and Conditions HTML that is displayed in the overlay. Currently available only for Tournaments due to technical limitations.

    • hidden boolean

      Campaign is not visible in the overlay

    • exclude_bonus_bets boolean

      Exclude bobus bets from campaign or not

    • exclude_cashout_bets boolean

      Exclude cashout bets from campaign or not

    • exclude_free_bets boolean

      Exclude free bets from campaign or not

    • exclude_system_bets boolean

      Exclude system bets from campaign or not

    • live_bet_settings allOf

      + - Show Child Attributes

      • allOf 1 string enum allOfenum

        An enumeration. Allowed values: LIVE_BETS, PRE_MATCH_BETS, BOTH.

    • minimum_bet string

      Minimum bet amount configured for the campaign

    • minimum_odds string

      Minimum odds configured for the campaign

    • sportsbook_missions[] object array

      List of all sportsbook mission

      + - Show Child Attributes

      • order integer

        The order of mission

      • prizes_info[] object array

        List of prizes can be won by participating this campaign

        + - Show Child Attributes

        • title string

          Prize title

        • games[] string array

          Game list

      • tasks[] object array

        Information of sportsbook mission tasks

        + - Show Child Attributes

        • minimum_bet string

          Minimum bet amount configured for the task

        • minimum_odds string

          Minimum odds configured for the task

        • order integer

          The order of task in a mission

        • title string

          Task title

        • prizes_info[] object array

          List of prizes can be won by completing this task

          + - Show Child Attributes

          • title string

            Prize title

          • games[] string array

            Game list