Skip to main content
POST
Attributes
Use the /Attributes endpoint to tell us the data points in your attributes package you want to retrieve.

Request Parameters

Note on ‘Filters’ and ‘AccountFilter’

The parameter AccountFilter can only be used in conjunction with Filter. You must have both present if you need to filter by specific accounts.

Note on ‘AttributesDetail’

Only Attributes that are ‘Sum’ or ‘Count’ are allowed here. ‘Average’ or other types of Attributes are not supported here. Any Attribute name that is included here must also be included in the mandatory Attributes parameter above.

Response Fields

Note on Custom Attributes

If you are utilizing the Attributes Builder feature to create custom Attributes within the Client Dashboard, then you are able to include your created Attribute Names under the card object alongside any other pre-created Attributes.

Headers

Content-Type
enum<string>
default:application/json
required

Content type of the request.

Available options:
application/json
Example:

"application/json"

Path Parameters

customerId
string
default:43387ca6-0391-4c82-857d-70d95f087ecb
required

Unique GUID provided by Flinks that grants you access to the environment specified in the instance field.

loginId
string
required

GUID representing end user's login ID.

requestId
string
required

GUID representing an authorized request to the API.

Query Parameters

limitDays
string
default:365

(Optional) Includes an integer from 1 to 365 that will limit the range of transactions that will be used to calculate Attributes.

Body

application/json
Attributes
object

Object specifying which attributes to retrieve, grouped by output target.

Filters
object

(Optional) Filters applied to the data used for attribute calculation.

Options
object

(Optional) Additional calculation options.

Response

Result

MostRecentTransactionDate
string

Date of the most recent transaction used in the calculation (MM/DD/YYYY).

GUID identifying the attributes calculation process.

HttpStatusCode
integer

HTTP status code of the response.

Card
object

Object containing an Id field (end user's LoginId) and all the requested attributes (name: value), plus optional AttributesDetail.

ProcessId
string

GUID identifying the request process.

Login
object

Object representing end user's technical information.

RequestId
string

GUID representing an authorized request to the API.