List Reward Transactions

Changed on

List reward transactions for earned reward items

get/reward-transactions/

Request

  • Base URL
    https://cf-blast.livelikecdn.com/api/v1
  • URL
    https://cf-blast.livelikecdn.com/api/v1/reward-transactions/
  • Auth
    none required

Query parameters

widget_idstring

Filters transactions by widget ID

widget_kindstring

Filters transactions by kind of widget, e.g. text-poll

profile_idstring

Filter transactions by destination profile ID

reward_item_idstring

Filter transactions by reward item ID

reward_action_keystring

Filter transactions by reward_action_key

created_sincestring date
created_untilstring date
attributesstring

Filter transactions by atribute's key/value

expires_atstring

Effective expiry — the earlier of the transaction's own expires_at and the reward item's earning_ends_at.

user_multiplier_urlstring

Link to this profile's reward-multiplier resource.

idempotency_keystring

Client-supplied key used to dedupe transaction creation requests.

transaction_type'credit' | 'debit'
expires_at_sincestring date-time

Filters reward transactions whose expires_at is on or after the specified date and time

expires_at_untilstring date-time

Filters reward transactions whose expires_at is on or before the specified date and time.

Response

200

previousunknown
countinteger
nextstring

Example response

{
  "results": [
    {
      "url": "https://cf-blast.livelikecdn.com/api/v1/reward-transactions/d6cf158d-0383-4b96-a9d9-a069827b93a2/",
      "profile_id": "2cb3fcb7-4ab7-488e-9121-e57176e3b3b9",
      "created_at": "2021-07-15T08:38:04.000Z",
      "reward_action_key": "poll-voted",
      "reward_action_id": "63e087b2-2f11-4406-a927-2c43e8a16209",
      "reason": "attend a game",
      "description": "attended an away game vs Atlanta Braves on April 30th",
      "reward_item_amount": 100,
      "reward_item_id": "f412f658-fc53-4924-8fed-8103d81a826d",
      "reward_action_name": "Voted on a poll",
      "reward_item_name": "Web Demo Reward",
      "id": "d6cf158d-0383-4b96-a9d9-a069827b93a2",
      "profile_nickname": "Intrepid Dog",
      "source": "quest-completed",
      "attributes": [
        {
          "key": "texture",
          "value": "smooth"
        }
      ]
    }
  ],
  "count": 3215,
  "next": "https://cf-blast.livelikecdn.com/api/v1/reward-transactions/?offset=20"
}

Changes

    • info

      added the new optional query request parameter expires_at

    • info

      added the new optional query request parameter expires_at_since

    • info

      added the new optional query request parameter expires_at_until

    • info

      added the new optional query request parameter idempotency_key

    • info

      added the new optional query request parameter transaction_type

    • info

      added the new optional query request parameter user_multiplier_url