v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

List Invoked Reward Actions

Invoke actions to trigger the rewards engine for that action

get/invoked-actions/

Query parameters

client_idstring required

The application's Client ID

codestring

The integrator-defined disambiguation code

profile_idstring

Limit results to a Profile ID. Repeat this parameter to filter for multiple Profile IDs

reward_action_keystring

Limit results to a Reward Action key. Repeat this parameter to filter for multiple Reward Action keys

program_idstring

Limit results to a Program ID

sincestring date

Filter for Invoked Actions created after a specific Date/Time

untilstring date

Filter for Invoked Actions created before a specific Date/Time

orderingstring

Order results by created Date/Time. Use -created_at to see most recent results first

attributesstring

Filter for actions with the given attributes. Example: attributes=key:value. This parameter can be repeated.

Response

200

countinteger

{"stackTrail":"paths:/invoked-actions/:get:responses:200:content:application/json:schema:properties:next","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/invoked-actions/:get:responses:200:content:application/json:schema:properties:previous","oasType":"schema","type":"unknown"}

Example response

{
  "count": 1,
  "results": [
    {
      "id": "9575428e-98a1-4c74-85fc-b2943f024224",
      "created_at": "2021-01-11T21:57:55.466092Z",
      "client_id": "pnODbVXg0UI80s0l2aH5Y7FOuGbftoAdSNqpdvo6",
      "program_id": "47c14e1d-5786-401e-a850-22c5a91a5399",
      "profile_id": "d70d8ad0-0753-4f2e-b00c-6defc295def7",
      "profile_nickname": "Expert Trainer",
      "reward_action_key": "hulk-slam",
      "code": "2021-01-11",
      "rewards": [
        {
          "reward_item_id": "ceb8b15e-3cee-480f-b25c-68817ac1afc0",
          "reward_item_name": "Hulk Points",
          "reward_item_amount": 100
        }
      ]
    }
  ]
}