Reviews

Get reviews

 
1GET https://api.markprompt.com/reviews

Retrieves reviews in the given time range.

Request body

Key Type Description Default
from string

The start of the range, as an ISO 8601 string.
to string

The end of the range, as an ISO 8601 string.
status "open" | "closed"

The status of the review. Omit to include all.
limit number

The maximum number of results to return.

 20
page number

The page index.

 0
projectKey string

Instead of the API token, use a project key, for instance for client-facing requests.

Example request

 
1curl "https://api.markprompt.com/reviews?from=2024-12-11T00%3A00%3A00&to=2024-12-12T00%3A00%3A00&limit=3&page=1" \
2  -X GET \
3  -H "Authorization: Bearer <TOKEN>" \
4  -H "Content-type: application/json" \
5  -H "Accept: application/json" \
6  -H "X-Markprompt-API-Version: 2024-05-21"

Response

The response is of the form:

 
1{
2  "object": "list",
3  "data": [
4    {
5      "id": "review-id-1",
6      "createdAt": "2024-12-11T09:52:56.000000+00:00",
7      "createdBy": "jane@acme.com",
8      "threadId": "thread-id-1",
9      "status": "open",
10      "pass": true,
11      "quality": 4,
12      "votes": {
13        "factuality": 1,
14        "tone": 1,
15        "references": -1
16      },
17      "assignees": ["jane@acme.com", "john@acme.com"],
18      "comments": [
19        {
20          "createdAt": "2024-12-11T09:52:59.000000+00:00",
21          "createdBy": "john@acme.com",
22          "comment": "It referenced an article about…"
23        }
24      ]
25    }
26    // ...
27  ]
28}