TAtalon
Customer data

List Applications events

Changed on

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.

get/v1/applications/{applicationId}/events/no_total

Request

Path parameters

applicationIdinteger required

The ID of the Application. It is displayed in your Talon.One deployment URL.

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.

Note: You may not be able to use all fields for sorting. This is due to performance limitations.

typestring

Comma-separated list of types by which to filter events. Must be exact match(es).

createdBeforestring date-time

Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.

createdAfterstring date-time

Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.

sessionstring

Session integration ID filter for events. Must be exact match.

profilestring

Profile integration ID filter for events. Must be exact match.

customerNamestring

Customer name filter for events. Will match substrings case-insensitively.

customerEmailstring

Customer e-mail address filter for events. Will match substrings case-insensitively.

couponCodestring

Coupon code

referralCodestring

Referral code

ruleQuerystring

Rule name filter for events

campaignQuerystring

Campaign name filter for events

effectTypestring

The type of effect that was triggered. See API effects.

Response

OK

hasMoreboolean required

Example response

{
  "data": [
    {
      "id": 6,
      "created": "2020-06-10T09:05:27.993483Z",
      "applicationId": 322,
      "profileId": 138,
      "storeIntegrationId": "STORE-001",
      "integrationId": "175KJPS947296",
      "effects": [
        {
          "experimentId": 12,
          "campaignId": 244,
          "rulesetId": 73,
          "ruleIndex": 2,
          "ruleName": "Give 20% discount",
          "effectType": "rejectCoupon",
          "triggeredByCoupon": 4928,
          "triggeredForCatalogItem": 786,
          "conditionIndex": 786,
          "evaluationGroupID": 3,
          "evaluationGroupMode": "stackable",
          "campaignRevisionId": 1,
          "campaignRevisionVersionId": 5,
          "selectedPriceType": "member",
          "selectedPrice": 100,
          "adjustmentReferenceId": "68851723-e6fa-488f-ace9-112581e6c19b",
          "rewardId": 7,
          "rewardIntegrationId": "reward-unlock-123",
          "props": {
            "value": "COUP-XYZ789"
          }
        }
      ],
      "ruleFailureReasons": [
        {
          "couponID": 4928,
          "rewardId": 7,
          "rewardIntegrationId": "5c0b5e6d-3f8a-4c2b-9f1e-2a7d6b4c8e90",
          "evaluationGroupID": 3,
          "evaluationGroupMode": "stackable"
        }
      ]
    }
  ]
}

Changes

  • 7ef1b9504c3aRevision changes
    • breaking

      added to the //// response property oneOf list for the response status

    • breaking

      the //// response's property type changed from no type to object for status

    • info

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

    • info

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

    • info

      removed subschema #2 from the //// response property allOf list for the response status

    • info

      added discriminator to //// response property for the response status