Get a mock server's call logs

GET

/mocks/:mockId/call-logs

GET

/mocks/:mockId/call-logs

$ curl https://api.getpostman.com/mocks/e3d951bf-873f-49ac-a658-b2dcb91d3289/call-logs \
>      -H "x-api-key: <apiKey>"

1 {
2   "call-logs": [
3     {
4       "id": "c4505a1e-7261-497c-91ff-db4bd51351a6-9545",
5       "responseName": "Double check your method and the request path and try again.",
6       "servedAt": "2022-01-17T06:19:30.000Z",
7       "request": {
8         "method": "POST",
9         "path": "/animals"
10       },
11       "response": {
12         "type": "error",
13         "statusCode": 404
14       }
15     },
16     {
17       "id": "0f63f54d-665e-436a-95b4-c1302d7685a9-3925",
18       "responseName": "Bad request",
19       "servedAt": "2022-01-17T06:19:22.000Z",
20       "request": {
21         "method": "POST",
22         "path": "/animals"
23       },
24       "response": {
25         "type": "success",
26         "statusCode": 400
27       }
28     },
29     {
30       "id": "adab0d30-5c38-43bf-af90-4119925138e2-3795",
31       "responseName": "Successful addition of animals to the store",
32       "servedAt": "2022-01-17T06:19:16.000Z",
33       "request": {
34         "method": "POST",
35         "path": "/animals"
36       },
37       "response": {
38         "type": "success",
39         "statusCode": 200
40       }
41     },
42     {
43       "id": "dae50669-f4c1-460a-b3a4-3a2445f4f39d-2468",
44       "responseName": "Get filtered list of Animals",
45       "servedAt": "2022-01-17T06:18:26.000Z",
46       "request": {
47         "method": "GET",
48         "path": "/animals?type=dog"
49       },
50       "response": {
51         "type": "success",
52         "statusCode": 200
53       }
54     },
55     {
56       "id": "a5330463-26e1-4812-a962-e44b569a2054-9894",
57       "responseName": "Get Animals",
58       "servedAt": "2022-01-17T06:18:06.000Z",
59       "request": {
60         "method": "GET",
61         "path": "/animals"
62       },
63       "response": {
64         "type": "success",
65         "statusCode": 200
66       }
67     }
68   ],
69   "meta": {
70     "nextCursor": null
71   }
72 }

Gets a mock server’s call logs. You can get a maximum of 6.5MB of call logs or a total of 100 call logs, whichever limit is met first in one API call.

Call logs contain exchanged request and response data made to mock servers. The logs provide visibility into how the mock servers are being used. You can log data to debug, test, analyze, and more, depending upon the use case.

Note:

Call logs have a retention period based on your Postman plan. For more information, see this article in the Postman Support Center.

Gets a mock server's call logs. You can get a maximum of 6.5MB of call logs or a total of 100 call logs, whichever limit is met first in one API call. Call logs contain exchanged request and response data made to mock servers. The logs provide visibility into how the mock servers are being used. You can log data to debug, test, analyze, and more, depending upon the use case. **Note:** Call logs have a retention period based on your [Postman plan](https://www.postman.com/pricing/#mock-calls). For more information, see [this article](https://support.postman.com/hc/en-us/articles/21219973964951-I-can-t-see-my-mock-server-logs-history) in the [Postman Support Center](https://support.postman.com/).

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

mockIdstringRequired

The mock's ID.

Query parameters

limitdoubleOptionalDefaults to 100

The maximum number of rows to return in the response.

cursorstringOptional

The pointer to the first record of the set of paginated results. To view the next response, use the nextCursor value for this parameter.

untildatetimeOptional

Return only results created until this given time, in ISO 8601 format. This value cannot be earlier than the since value.

Return only results created until this given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than the `since` value.

sincedatetimeOptional

Return only results created since the given time, in ISO 8601 format. This value cannot be later than the until value.

Return only results created since the given time, in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the `until` value.

responseStatusCodedoubleOptional

Return only call logs that match the given HTTP response status code.

responseTypestringOptional

Return only call logs that match the given response type. Matching is not case-sensitive.

requestMethodstringOptional

Return only call logs that match the given HTTP method. Matching is not case-sensitive.

requestPathstringOptional

Return only call logs that match the given request path. Matching is not case-sensitive.

sortenumOptional

Sort the results by the given value. If you use this query parameter, you must also use the direction parameter.

Allowed values:

directionenumOptional

Sort in ascending (asc) or descending (desc) order. Matching is not case-sensitive. If you use this query parameter, you must also use the sort parameter.

Allowed values:

includestringOptional

Include call log records with header and body data. This query parameter accepts the request.headers, request.body, response.headers, and response.body values. For multiple include types, comma-separate each value.

Response

Successful Response

call-logslist of objects

A list of call logs.

metaobject

The response’s non-standard meta information.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error