Kard users > attributions API is one of 17 APIs that Kard publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include users > attributions. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an AsyncAPI specification.
This API exposes
4 operations
across 4 paths,
and defines 69 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://rewards-api.getkard.com, https://test-rewards-api.getkard.com.
The identity and technical contract details declared by the specification.
type_users_attributions_PlacementSlotAttributionAttributes
object
Attributes for a slot-level activation event on a batch-activation placement. A slot activation also writes per-offer offerAttribution ACTIVATE events for ever…
5 properties
4 required
type_users_rewards_ProgressBarSegments
object
Segment configuration for the progress bar in different layouts
3 properties
2 required
type_users_attributions_CreateAttributionResponse
object
1 property
1 required
type_commons_ResourceType
string
Type of document returned
type_users_attributions_AttributionState
object
4 properties
type_commons_PurchaseChannel
string
Purchase channel of offer
type_users_attributions_AttributionFilter
object
2 properties
2 required
type_users_rewards_CategoryFields
object
1 property
1 required
type_users_rewards_CategoryData
object
2 properties
2 required
type_users_rewards_ProgressBarSegmentSelection
string
Supported selection strategies for highlighting segment nodes. - CURRENT: select only the segment at currentProgress - CURRENTANDBELOW: select the segment at c…
type_users_rewards_AmountType
string
type_commons_CategoryOption
string
Category of merchant. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)
type_users_rewards_CategoryRelationship
object
1 property
1 required
type_users_rewards_ProgressBarSegmentProgress
object
Fill state of a single segment node, expressed as completed of total.
2 properties
2 required
type_users_rewards_LogoFlareBorderColor
string
Available border color options for logo flare
type_commons_MongoId
string
The unique identifier for a document in the database
type_users_attributions_ActivateOfferResponse
object
2 properties
1 required
type_commons_ErrorObject
object
5 properties
3 required
type_users_rewards_Amount
object
2 properties
2 required
type_users_attributions_ActivateOfferIncludeOption
string
Options for what to include in the activate offer response
type_commons_JobResponse
object
3 properties
3 required
type_users_attributions_NotificationAttributionAttributes
object
5 properties
4 required
type_users_attributions_ActivateOfferResponseData
object
3 properties
3 required
type_users_attributions_OfferAttributionAttributes
object
5 properties
4 required
type_users_rewards_CtaComponent
object
Call-to-action button component for offers
4 properties
2 required
type_commons_JobStatus
string
Status of the job
type_commons_Job
object
2 properties
2 required
type_users_rewards_OfferComponents
object
UI component data for rendering offer details
9 properties
type_users_rewards_CategoryRelationshipObject
object
1 property
1 required
type_users_rewards_Commission
object
2 properties
2 required
type_commons_ErrorSource
object
3 properties
type_commons_CommissionType
string
Type of commission on offer (% or a flat $)
type_users_attributions_CreateAttributionRequestUnion
type_users_attributions_NotificationMedium
string
Where the notification attribution event is taking place in your rewards experience.
type_users_attributions_BoostOfferResponse
object
2 properties
1 required
type_users_rewards_CategoryIncluded
object
3 properties
3 required
type_users_rewards_ProgressBarSegment
object
Segment configuration for a specific layout
5 properties
1 required
type_users_rewards_ProgressBar
object
Progress bar component for tracking offer redemption progress
6 properties
5 required
type_users_rewards_ButtonStyle
string
Available button styles for CTA components
type_users_attributions_BoostOfferResponseAttributes
object
4 properties
4 required
type_users_rewards_ComponentType
string
Available UI component types for offers
type_users_attributions_BoostOfferIncluded
type_users_attributions_ActivateOfferIncluded
type_commons_ErrorResponse
object
1 property
1 required
type_users_rewards_ProgressBarLabelPair
object
Left and right label configuration for a specific layout
2 properties
type_users_attributions_BoostOfferResponseData
object
3 properties
3 required
type_commons_UserId
string
The ID of the user as defined on the issuers system
type_users_rewards_OfferDataUnion
type_users_rewards_ProgressBarSegmentLabel
object
Label configuration for a single node within a segment
2 properties
2 required
type_users_attributions_OfferMedium
string
Where the offer attribution event is taking place in your rewards experience.
type_commons_OrganizationId
string
Your issuer organization ID, provided by Kard
type_users_rewards_ProgressBarSegmentPosition
string
Supported segment positions
type_users_attributions_BoostOfferIncludeOption
string
Options for what to include in the boost offer response
type_users_rewards_CtaAction
object
Action configuration for CTA button
2 properties
2 required
type_users_rewards_LogoFlareBadgePosition
string
Available positions for the logo flare badge
type_users_attributions_ActivateOfferResponseAttributes
object
4 properties
4 required
type_users_rewards_StandardOfferFields
object
16 properties
8 required
type_users_rewards_Asset
object
3 properties
3 required
type_users_rewards_EligibilityOfferRelationship
type_users_attributions_ActivatePlacementSlotResponse
object
Ack payload for a slot activation request.
1 property
1 required
type_users_rewards_LogoFlareBadge
object
Badge configuration for logo flare
2 properties
2 required
type_users_rewards_LogoFlare
object
Logo flare configuration for offer display
2 properties
1 required
type_users_attributions_CreateAttributionRequestObject
object
1 property
1 required
type_users_attributions_PlacementSlotMedium
string
Where the placement-slot attribution event is taking place in your rewards experience.
type_users_attributions_ActivatePlacementSlotResponseAttributes
object
6 properties
6 required
type_users_attributions_ActivatePlacementSlotResponseData
object
3 properties
3 required
type_users_rewards_ProgressBarSegmentSeparator
string
Supported separator styles between segment nodes
type_users_attributions_EventCode
string
The event code of attribution event.
type_users_rewards_ProgressBarLabels
object
Labels to render around the progress bar in different layouts
2 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Kard publishes across the network.
