Welcome to the Uptick API documentation! Our API empowers publishers to seamlessly integrate our ad platform into their offer flow, enabling them to provide targeted offers to their users at crucial moments during the checkout process or while waiting for order delivery. By leveraging our API, publishers can enhance user experience and maximize revenue opportunities.

Key Benefits

  1. Seamless Integration: Our API is designed for easy integration into your existing offer flow, minimizing development time and effort.
  2. Targeted Offers: With access to our platform, publishers can request tailored offers based on user behavior, preferences, and transaction data, ensuring relevance and effectiveness.
  3. Enhanced Monetization: By incorporating our ad units into your offer flow, you can unlock additional revenue streams while delivering value to your users.

Getting Started

To begin integrating with our API, publishers will need to obtain an integration id by registering for an account on our platform.

New Offer Flow

This endpoint allows publishers to create a new offer flow for end users, defining the parameters and triggers for displaying relevant offers.

Next Offer

Publishers can use this endpoint to request offers for a specific offer flow, triggering the retrieval of targeted offers from our platform.

Next Steps

Explore the detailed documentation for each endpoint to understand how to make requests, handle responses, and integrate our API seamlessly into your offer flow. If you have any questions or need assistance, our support team is here to help.

Resources

Events

Resource Description
POST /v1/places/:integration_id/flows/:flow_id/events Flow Event

Flows

Resource Description
GET /v1/places/:integration_id/flows/new New Offer Flow
GET /v1/places/:integration_id/flows/:id Show Offer Flow

Offers

Resource Description
GET /v1/places/:integration_id/flows/:flow_id/offers/new Next Offer
GET /v1/places/:integration_id/flows/:flow_id/offers/:id Show Offer