Get partner app ratings

get

https://partner.gupshup.io/partner/bizgate/app/{appId}/access/ratings

Returns the current messaging quality rating and related signals for the app's WhatsApp number, as reported by Meta.

Request parameters

Path parameters

Key	Description	Values	Data Type	Required/Optional
appId	Identifier of the WhatsApp app the call acts on.	6f414190-d45c-4671-bca1-fb6c3018cb13	String	Required

Sample cURL — Get partner app ratings.

curl --request GET \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/access/ratings' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json'

Sample success response (200)

{
  "status": "success",
  "data": {
    "oldLimit": "TIER_1K",
    "currentLimit": "TIER_10K",
    "event": "FLAGGED",
    "eventTime": 1721088316000,
    "phoneQuality": "GREEN"
  }
}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

Universal Token (UT)

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400No app exists for the given appId, or the app exists but has no rating data yet (its number has never reported a quality event). The two cases are distinguished by the response message.

401Unauthorized — missing, expired, or invalid bearer token

403App is not linked to the authenticated partner

429Rate limit exceeded for this endpoint

500An unhandled failure — the request did not fail a check, the server did