Open API

Duel provides an open API that can be used to retrieve programme data and assets or send e-commerce order updates.

Members
Events
Orders 
Assets 

Duel provides an open API that can be used to retrieve programme data and assets or send e-commerce order updates.

Members

Brand partners can use the API to retrieve detailed information about their members, including lists of all members or data for a specific individual. This data can then be utilised to customise and enhance communications, such as displaying personalised data on their e-commerce. 

Events 

The API also allows access to events within a brand's Duel program, like completed tasks or member advancements. This feature enables the triggering of communications from external sources, such as email or text, to further enhance engagement with members.

• action_approval: This event is triggered when an action submitted by a member, like a referral or social post, is approved by the brand’s team or automatically by the system. It signals that the action is valid for rewards or recognition.
• action_rejection: This event is triggered when an action submitted by a member is rejected. This usually happens if the action doesn’t meet the program’s guidelines, such as content that isn’t appropriate or a referral that doesn’t qualify.
• action_submission: This event is recorded when a member submits an action, such as uploading content, referring a friend, or completing a campaign task. It marks the moment before any approval or rejection happens.
• member_acceptance: This event happens when a new member joins a program, accepts an invitation, or is officially welcomed into an ambassador or loyalty campaign.
• member_payment: This event is logged when a member receives a cash payment, usually as a commission for successful referrals or for completing actions that result in monetary rewards.
• member_reward: This event records when a member earns a reward that isn’t cash-based, such as points, vouchers, or free products, for their participation or completed actions.
• member_tier_up: This event is triggered when a member moves up to a higher level in the program’s tier system, typically based on their activity, referrals, or points collected.
• member_update: This event is recorded when something changes in a member’s profile, such as updating their name, email, or other details, either by the member or an admin.
• purchase_completion: This event logs when a tracked purchase has been completed by a customer. This is often tied to referral or affiliate programs where confirming a completed purchase is essential for rewards and tracking.
• purchase_update: This event is triggered when there’s an update to a previously tracked purchase. It could be a change in the order status, such as when an order is canceled or partially refunded. These updates make sure that rewards, commissions, and reporting stay accurate. (For more details on the types of order updates, see: https://info.duel.tech/help/commission-status-update-jan-2025)
• social_post_refresh: This event is logged when a social post linked to a campaign is refreshed. This can happen either when the system pulls updated engagement metrics, like likes or comments, or when the user edits or resubmits the content for validation.
• task_completion: This event records when a member completes a specific task within a program, such as sharing something on social media, completing a challenge, or submitting content.

Orders 

Brand partners can use the API to input orders into the Duel dashboard, facilitating order tracking through our script and server setup. This functionality empowers brands to incentivize advocates for successful referrals and monitor the utilization of rewards efficiently.

• Order Tracking Documentation

Assets 

Brand partners can retrieve all their assets from the Duel platform, enabling efficient repurposing of User-Generated Content (UGC) giving them the ability to create custom galleries on their ecom. 

New API Endpoint: /api/v1/assets

• Attributes Returned:
  • file_url: The original file URL, or large version if original is unavailable.
  • file_type: MIME type of the asset (e.g., "image/jpeg").
  • date: DateTime when the asset was uploaded or created.
  • source: Origin of the asset (ugc or operator).
  • task_id: Associated task identifier, if applicable.
  • member_id: Identifier of the member who uploaded the asset, or empty if uploaded by an operator.
  • product_skus: List of associated product SKUs.
  • social_post_domain: Platform from which the UGC was sourced (e.g., "Instagram").
  • social_post_url: URL to the original social post.

How to Use the Assets API Endpoint

1. Authentication: Ensure you have valid API credentials with Duel.
2. GET Request:
   • URL: /api/v1/assets
   • Method: GET
   • Headers:
     • Authorization: Bearer <your_access_token>

Response Format:
The response will contain a JSON array of asset information as described above.

Rate Limits

• Response Time: 100ms to 500ms
• Rate Limit: Up to 1,500 requests per minute
• Retry Policy: Maximum of 5 retries, with a 5-minute interval between each attempt