API Integration (Advanced)

Get Progress API

Look up everything a user has done on your wall: in-progress offers, credited rewards, pending credits, and reversals, each with per-step detail.

Overview

The Get Progress API lets you check the progress a specified user has made on the offers they have started. It returns a real-time snapshot of every offer that user has engaged with, including offers that are in progress, completed, pending credit, or expired.

Note that the response only includes offers the user has actively engaged with, not a full inventory of available offers. It is the natural companion to the Get Personalized API: where Get Personalized tells you what offers to show a user next, Get Progress tells you what that user has already started, completed, or is waiting on.

It uses the same offer vocabulary as the rest of the RevU API suite, so offer objects will look familiar if you have already integrated Get Offers or Get Personalized.

How it works

  1. Send a GET request with the required wall ID and user_id. No API key is required or validated.

  2. Read offer progress and each event’s reward status, completion timestamp and points awarded when available.

  3. Render history, in-progress or support views from that response.

Request current progress when it is needed. By default, progress is limited to the requested wall. If RevU has enabled publisher-wide wall unification for that wall, the same user’s progress can include other walls belonging to that publisher. Currency display uses the requested wall’s settings.

Use Cases

  • Populate an offer history or in-progress screen showing all offers the user has started.

  • Give your support team instant access to a user’s offer history when handling a dispute or reward inquiry. It can also be used with chatbots and automated tools (like Intercom’s Fin AI).

  • When a user returns to an offer details page, refresh their state in real time so they can see their progress.

User identification

No API key is required or validated. Both wall and user_id are required. The REST URL is /api/v1/users/{user_id}/getprogress; the legacy URL /getprogress_api.php?user_id=YOUR_USER_ID is also supported. URL-encode the actual user identifier and use the same identifier that was passed on the click.

Repeat offers and completion history

To check a specific offer, request /api/v1/users/{user_id}/getprogress?wall={wall_id}&offer_id={offer_id} using the same wall and user IDs as the click; URL-encode the user ID. Read offers[].repeat_available for the repeat-count and applicable account-age result. Read each event’s user_completed_at with event_reward_status to distinguish credited, pending, reversed and tracking-only activity.

once_per_day normally uses the service’s calendar date, not a rolling 24-hour interval. There is no last-24-hours query filter or exact repeat-reset timestamp. Progress records are not a complete conversion ledger, and empty progress does not prove eligibility. See the Get Progress technical guide for the true/false/null meanings and use Get Personalized for current user-specific selection.

Share feedback on this documentation

On this page

On this page