/xiaomigetapps/apps/permissions

POST /api/xiaomigetapps/apps/permissions

Price: 1 credit

Get the Android permissions a Xiaomi GetApps app declares

How to use it

Resolve one app's declared Android permissions into readable entries. GetApps stores them as opaque numeric indexes, so this is the only way to read them by name. An app can legitimately declare none, which is 200 with an empty list, not an error. label, description, risk_category and permission_group come from the storefront's own permission dictionary and the dictionary is sparse: label and description are absent for roughly one permission in ten, risk_category for about seven in ten and permission_group for about eight in ten, where the storefront itself has no entry — name is always present. Use the app endpoint instead if you want the permission names alongside the rest of the app record.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• package_name string required — Android package name, or a GetApps app URL (examples: "com.zhiliaoapp.musically", "com.instagram.android", "https://global.app.mi.com/details?id=com.whatsapp"; minLength: 1)
• region string — Storefront region as an ISO 3166-1 alpha-2 code. The app must be distributed to it (default: "ID"; examples: "ID", "IN", "BR"; minLength: 2; maxLength: 2)

Response

• @type string (default: "XiaomigetappsPermission")
• name string required
• label string nullable
• description string nullable
• risk_category string nullable
• permission_group string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No app with this package name is distributed to the requested region Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.