Reviewers¶
Reviewer API provides access to the reviewer tools.
Reviewer Search¶
Note
Requires authentication and permission to review apps.
-
GET
/api/v2/reviewers/search/
¶ Performs a search just like the regular Search API, but customized with extra parameters and different (smaller) apps objects returned, containing only the information that is required for reviewer tools.
Response:
Parameters: - meta (object) – Listing response meta.
- objects (array) – A listing of apps.
Status Codes: - 200 OK – successfully completed.
Each app in the response will contain the following:
Parameters: - device_types (array) – a list of the device types at least one of: desktop, mobile, tablet, firefoxos. mobile and tablet both refer to Android mobile and tablet. As opposed to Firefox OS.
- id (int) – the app’s id.
- is_escalated (boolean) – a boolean indicating whether this app is currently in the escalation queue or not.
- is_packaged (boolean) – a boolean indicating whether the app is packaged or not.
- latest_version (object) – an array containing the following information about the app’s latest version:
- latest_version.has_editor_comment (boolean) – a boolean indicathing whether that version contains comments from a reviewer.
- latest_version.has_info_request (boolean) – a boolean indicathing whether that version contains an information request from a reviewer.
- latest_version.is_privileged (boolean) – a boolean indicating whether this version is a privileged app or not.
- latest_version.status (int) – an int representing the version status. Can be different from the app status, since the latest_version can be different from the latest public one.
- name (string) – the name of the app
- premium_type (string) – one of
free
,premium
,free-inapp
,premium-inapp
. Ifpremium
orpremium-inapp
the app should be bought, check theprice
field to determine if it can. - price (string|null) – If it is a paid app this will be a string representing
the price in the currency calculated for the request. If
0.00
then no payment is required, but the app requires a receipt. Ifnull
, a price cannot be calculated for the region and cannot be bought. Example: 1.00 - name – the URL slug for the app
- status – an int representing the version status.
Reviewing¶
Note
Requires authentication and permission to review apps.
Warning
Not available through CORS.
-
GET
/api/v2/reviewers/reviewing/
¶ Returns a list of apps that are being reviewed.
Response:
Parameters: - meta (object) – Listing response meta.
- objects (array) – A listing of apps.
Status Codes: - 200 OK – successfully completed.
Mini-Manifest¶
Note
Requires authentication and permission to review apps.
Warning
Not available through CORS.
-
POST
/api/v2/reviewers/app/
(int: id)|
(string: slug)/token
¶ Returns a short-lived token that can be used to access the mini-manifest. Use this token as a query-string parameter to the mini-manifest URL named “token” within 60 seconds.
Response:
Parameters: - token – The token.
Status Codes: - 200 OK – successfully completed.
Canned Responses¶
Note
Requires authentication and permission to alter reviewer tools.
-
GET
/api/v1/reviewers/canned-responses/
¶
-
POST
/api/v1/reviewers/canned-responses/
¶
-
GET
/api/v1/reviewers/canned-responses/
(int: id)/
¶
-
PUT
/api/v1/reviewers/canned-responses/
(int: id)/
¶
-
PATCH
/api/v1/reviewers/canned-responses/
(int: id)/
¶
-
DELETE
/api/v1/reviewers/canned-responses/
(int: id)/
¶ Return, create, modify and delete the canned responses reviewers can use when reviewing apps.
Response / Request parameters:
Parameters: - id (int) – unique identifier for the canned response.
- name (string|object|null) – canned response name.
- response (string|object|null) – canned response text.
- sort_group (string) – group the canned response belongs to.
Status Codes: - 200 OK – successfully completed.
- 201 Created – successfully created.
- 204 No Content – successfully deleted.
- 400 Bad Request – error processing the request.
- 404 Not Found – not found.
Reviewer Scores¶
Note
Requires authentication and permission to alter reviewer tools.
-
GET
/api/v1/reviewers/scores/
¶
-
POST
/api/v1/reviewers/scores/
¶
-
GET
/api/v1/reviewers/scores/
(int: id)/
¶
-
PUT
/api/v1/reviewers/scores/
(int: id)/
¶
-
PATCH
/api/v1/reviewers/scores/
(int: id)/
¶
-
DELETE
/api/v1/reviewers/scores/
(int: id)/
¶ Return, create, modify and delete the reviewer scores for an user. This API only deals with manual scores, and never returns or allows you to modify automatic ones.
Response / Request parameters:
Parameters: - id (int) – unique identifier for the reviewer score.
- score (int) – score value (can be negative).
- note (string) – optional note attached to the score.
Status Codes: - 200 OK – successfully completed.
- 201 Created – successfully created.
- 204 No Content – successfully deleted.
- 400 Bad Request – error processing the request.
- 404 Not Found – not found.