Sign in
LiveOps

Get Campaigns

get/v1/campaigns

Query parameters

resource_state'active' | 'archived'
enabledboolean
'game_hub_visit' | 'game_hub_visit_store' | 'game_hub_first_login' | 'game_hub_login' | 'add_segment' | 'coupon_redeemed' | 'registered_in_game' | 'game_login' | 'purchased_in_game' | 'purchased_in_web' | 'abandoned_cart' | 'level_up' | 'custom_event' | 'free_item_claimed' | 'daily_reward_claimed' | 'loyalty_reward_claimed' | 'progression_reward_claimed' | 'payment_insufficient_funds' | 'subscription_status_updated' | 'subscription_schedule' | 'pwa_installed' | 'pwa_deinstalled' | 'pwa_open' | 'web_push_subscribed' | 'email_submitted' | 'discord_linked'
OR
string
limitinteger

A limit on the number of objects to be returned

A limit on the number of objects to be returned

offsetinteger

The number of objects to skip

The number of objects to skip

Response

Successful Response

namestring required
descriptionstring
enabledboolean required
time_limitboolean
start_atnumber
end_atnumber
archived_atnumber
positioninteger
allowed_popups_on_storeboolean
is_syncboolean
idstring required
versionstring
created_by_customer_idstring
created_from_idstring
version_descriptionstring required
modified_atinteger
created_atinteger required

Changes

Changed in 7 of the 28 revisions of this API.176

  • 1816e2044c07111See the full diff
    • ▲

      the response property //// became optional for the status

      response-property-became-optional

    • ●

      added the new function enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dd5e5e9f81ef1See the full diff
    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

  • fb9750c99d0a3See the full diff
    • ●

      for the query request parameter limit, the exclusiveMinimum was set to 1.00

      request-parameter-exclusive-min-set

    • ●

      for the query request parameter limit, the max was set to 300.00

      request-parameter-max-set

    • ●

      for the query request parameter offset, the min was set to 0.00

      request-parameter-min-set

  • 6d6269f8cab611See the full diff
    • ●

      added the new discord_linked enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value discord_linked to the property anyOf[subschema #1: CampaignEventType]/ of the query request parameter type

      request-parameter-property-enum-value-added

  • 5e18ab67333211See the full diff
    • ●

      added the new web_push_subscribed enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value web_push_subscribed to the property anyOf[subschema #1: CampaignEventType]/ of the query request parameter type

      request-parameter-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2fecf8a6aa0b11See the full diff
    • ●

      added the new email_submitted enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the enum value email_submitted to the property anyOf[subschema #1: CampaignEventType]/ of the query request parameter type

      request-parameter-property-enum-value-added

  • aad0f133191e1See the full diff
    • ○

      added the optional property //// to the response with the status

      response-optional-property-added