TAtalon
Referrals

Export referrals

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

Download a CSV file containing the referrals that match the given parameters.

[!tip] If the exported CSV file is too large to view, you can split it into multiple files.

The CSV file contains the following columns:

  • code: The referral code.
  • advocateprofileintegrationid: The profile ID of the advocate.
  • startdate: The start date in RFC3339 of the code redemption period.
  • expirydate: The end date in RFC3339 of the code redemption period.
  • limitval: The maximum number of redemptions of this code. Defaults to 1 when left blank.
  • attributes: A json object describing custom referral attribute names and their values.
get/v1/applications/{applicationId}/export_referrals

Request

Path parameters

applicationIdinteger required

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

Query parameters

campaignIdnumber

Filter results by campaign ID.

createdBeforestring date-time

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

createdAfterstring date-time

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

valid'expired' | 'validNow' | 'validFuture'
  • expired: Matches referrals in which the expiration date is set and in the past.
  • validNow: Matches referrals in which start date is null or in the past and expiration date is null or in the future.
  • validFuture: Matches referrals in which start date is set and in the future.
usable'true' | 'false'
  • true, only referrals where usageCounter < usageLimit will be returned.
  • false, only referrals where usageCounter >= usageLimit will be returned.
batchIdstring

Filter results by batches of referrals

dateFormat'excel' | 'ISO8601'

Determines the format of dates in the export document.

Response

OK

Changes

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