TAtalon
Campaigns

Get analytics of campaigns

[!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.

Retrieve statistical data about the performance of the given campaign.

get/v1/applications/{applicationId}/campaigns/{campaignId}/analytics

Request

Path parameters

applicationIdinteger required

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

campaignIdinteger required

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

Query parameters

rangeStartstring date-time required

Only return results from after this timestamp.

[!note] Note

  • This must be an RFC3339 timestamp string.
  • You can include a time component in your string, for example, T23:59:59 to specify the end of the day. The time zone setting considered is UTC. If you do not include a time component, a default time value of T00:00:00 (midnight) in UTC is considered.
rangeEndstring date-time required

Only return results from before this timestamp.

[!note] Note

  • This must be an RFC3339 timestamp string.
  • You can include a time component in your string, for example, T23:59:59 to specify the end of the day. The time zone setting considered is UTC. If you do not include a time component, a default time value of T00:00:00 (midnight) in UTC is considered.
granularity'1 hour' | '1 day' | '1 week' | '1 month' | '1 year'

The time interval between the results in the returned time-series.

Response

OK

totalResultSizeinteger required

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "date": "2021-10-12T10:12:42Z",
      "campaignRevenue": 3539.76,
      "totalCampaignRevenue": 5784.63,
      "totalCampaignFreeItems": 86,
      "addedLoyaltyPoints": 250,
      "totalAddedLoyaltyPoints": 340,
      "deductedLoyaltyPoints": 120,
      "totalDeductedLoyaltyPoints": 220
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.