LiveOps

Get Campaigns

Changed on
get/v1/campaigns

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/campaigns
  • Auth
    HTTP bearer

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' | 'automation' | 'upsell'
OR
string
limitinteger

A limit on the number of objects to be returned

offsetinteger

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

  • 80eff580084aRevision changes
    • warning

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

    • info

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

  • 0ef278347679Revision changes
    • info

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

    • info

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