reviews

Record a rating-ask action

Record what happened with the rating ask. shown / requested claim it (first device wins, applied: false means do not show). rated / dismissed answer an open web card.

post/reviews/prompt

Request

  • Base URL: https://api.aiapplyd.com/api/v1
  • URL: https://api.aiapplyd.com/api/v1/reviews/prompt
  • Auth: HTTP bearer

Request body

action'shown' | 'requested' | 'rated' | 'dismissed' required

shown (web card rendered) and requested (native OS ask) claim the ask. rated and dismissed answer a shown web card.

platform'web' | 'ios' | 'android' required

Surface that showed the rating ask: the web app, the iOS app or the Android app.

Example request

{
  "action": "shown",
  "platform": "ios"
}

Response

Whether the action was applied, and the resulting status.

successtrue required

Example response

{
  "data": {
    "applied": true,
    "prompt": {
      "shouldPrompt": true,
      "trigger": "landed"
    }
  },
  "meta": {
    "duration": 150,
    "requestId": "req_abc123",
    "timestamp": "2026-10-13T10:27:20.268Z",
    "version": "v1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.