delphiDll / Postman API / Single Monitor
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
email: PWideChar;
Id: PWideChar;
Name: PWideChar;
Uid: PWideChar;
Owner: PWideChar;
CollectionUid: PWideChar;
EnvironmentUid: PWideChar;
StrictSSL: Boolean;
FollowRedirects: Boolean;
RequestTimeout: Integer;
RequestDelay: Integer;
Cron: PWideChar;
Timezone: PWideChar;
NextRun: PWideChar;
Status: PWideChar;
StartedAt: PWideChar;
FinishedAt: PWideChar;
Total: Integer;
Failed: Integer;
RequestsTotal: Integer;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_SetRequestHeader(http,'X-API-Key','{{postman_api_key}}');
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.getpostman.com/monitors/{{monitor_uid}}',sbResponseBody);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttp__lastHeader(http));
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "monitor": {
// "id": "1e6b6cc1-c760-48e0-968f-4bfaeeae9af1",
// "name": "Postman Echo Monitor",
// "uid": "5852-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1",
// "owner": "5852",
// "collectionUid": "5852-8d05dd85-222c-1452-553b-e76a531b71ed",
// "environmentUid": "5851-8d05dd85-222c-1452-553b-e76a531b71ed",
// "options": {
// "strictSSL": true,
// "followRedirects": true,
// "requestTimeout": 3000,
// "requestDelay": 0
// },
// "notifications": {
// "onError": [
// {
// "email": "john.appleseed@example.com"
// }
// ],
// "onFailure": [
// {
// "email": "john.appleseed@example.com"
// }
// ]
// },
// "distribution": [
// ],
// "schedule": {
// "cron": "0 0 * * * *",
// "timezone": "Asia/Calcutta",
// "nextRun": "2016-11-30T09:30:00.000Z"
// },
// "lastRun": {
// "status": "failed",
// "startedAt": "2020-03-25T15:45:29.218Z",
// "finishedAt": "2020-03-25T15:45:31.340Z",
// "stats": {
// "assertions": {
// "total": 8,
// "failed": 1
// },
// "requests": {
// "total": 4
// }
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id := CkJsonObject__stringOf(jResp,'monitor.id');
Name := CkJsonObject__stringOf(jResp,'monitor.name');
Uid := CkJsonObject__stringOf(jResp,'monitor.uid');
Owner := CkJsonObject__stringOf(jResp,'monitor.owner');
CollectionUid := CkJsonObject__stringOf(jResp,'monitor.collectionUid');
EnvironmentUid := CkJsonObject__stringOf(jResp,'monitor.environmentUid');
StrictSSL := CkJsonObject_BoolOf(jResp,'monitor.options.strictSSL');
FollowRedirects := CkJsonObject_BoolOf(jResp,'monitor.options.followRedirects');
RequestTimeout := CkJsonObject_IntOf(jResp,'monitor.options.requestTimeout');
RequestDelay := CkJsonObject_IntOf(jResp,'monitor.options.requestDelay');
Cron := CkJsonObject__stringOf(jResp,'monitor.schedule.cron');
Timezone := CkJsonObject__stringOf(jResp,'monitor.schedule.timezone');
NextRun := CkJsonObject__stringOf(jResp,'monitor.schedule.nextRun');
Status := CkJsonObject__stringOf(jResp,'monitor.lastRun.status');
StartedAt := CkJsonObject__stringOf(jResp,'monitor.lastRun.startedAt');
FinishedAt := CkJsonObject__stringOf(jResp,'monitor.lastRun.finishedAt');
Total := CkJsonObject_IntOf(jResp,'monitor.lastRun.stats.assertions.total');
Failed := CkJsonObject_IntOf(jResp,'monitor.lastRun.stats.assertions.failed');
RequestsTotal := CkJsonObject_IntOf(jResp,'monitor.lastRun.stats.requests.total');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'monitor.notifications.onError');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
email := CkJsonObject__stringOf(jResp,'monitor.notifications.onError[i].email');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'monitor.notifications.onFailure');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
email := CkJsonObject__stringOf(jResp,'monitor.notifications.onFailure[i].email');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'monitor.distribution');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X GET
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/monitors/{{monitor_uid}}
Postman Collection Item JSON
{
"name": "Single Monitor",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/monitors/{{monitor_uid}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"monitors",
"{{monitor_uid}}"
]
},
"description": "This endpoint fetches you basic information about the monitor using its `uid`.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Monitor Not Found",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/monitors/{{monitor_uid}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"monitors",
"{{monitor_uid}}"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
{
"expires": "Invalid Date",
"hostOnly": false,
"httpOnly": false,
"domain": "getpostman.com",
"path": "/",
"secure": false,
"session": false,
"value": "yes",
"key": "getpostmanlogin"
},
{
"expires": "Invalid Date",
"hostOnly": false,
"httpOnly": false,
"domain": "getpostman.com",
"path": "/",
"secure": false,
"session": false,
"value": "0e9f9b1f3e7218e7fd625cca14597bc771064a433bdd75b5a40196cef86c3fa29d483358e0b254b0a097ac305b132ec8481e2c5b835663fbed3bbb93b5a747cf8776efe85650e29a8e5f0a63906480e5b9e5a9860bef703234812ce9f65ea6dcbc099ac952d1c36338e2d192a793b82a1d8a2dd6dd031f831c08805a9e7ea1f55d46c54cf6ecaecbac84ddf581c8a267a116c0d6d935f19171bce93c6e040c0bd49fc1325bdb8929914548d7c0cae78796aba4073dc9ab63194a90e430919d8757c7ccb7b4dffc61b9cd4a748edc88d0b4ba727c83ea1af546908ff63a1e2ee9784a7b9af2f61997e0dd34adcb479151d11d0e8d67ba76050d55c7bbb88f2f700e14f848f6b929b441869fba53436eb7983660d0e4af82aa0dc5c47dddf974599280179889c03c3e38212eaa8270c641298f0a49b923ed3d04d61e2c6c25844b67df9e4814d378b440e8124e429dc292a147038a57c03e8b8ece700b376fcf8e002dca35142f97b5f49144e2f7477b99d767dff12bb37dd846419051bdaa4c6d931545a5df09bda8a80a336585e5d6ba44f087607512344f91321a359dc150cb411600fbf0d974f63116046d681d3f82a16e50e3bb69c463430e284f64e007f354a9ed4a2afdb27caad0414d451875ec78ea98924e32d8f881eb2c260b348e00baf782",
"key": "postman.sid"
}
],
"body": "{\n \"error\": {\n \"name\": \"instanceNotFoundError\",\n \"message\": \"The specified monitor does not exist.\"\n }\n}"
},
{
"name": "Successful Response",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/monitors/{{monitor_uid}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"monitors",
"{{monitor_uid}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
{
"expires": "Invalid Date",
"hostOnly": false,
"httpOnly": false,
"domain": "getpostman.com",
"path": "/",
"secure": false,
"session": false,
"value": "yes",
"key": "getpostmanlogin"
},
{
"expires": "Invalid Date",
"hostOnly": false,
"httpOnly": false,
"domain": "getpostman.com",
"path": "/",
"secure": false,
"session": false,
"value": "0e9f9b1f3e7218e7fd625cca14597bc771064a433bdd75b5a40196cef86c3fa29d483358e0b254b0a097ac305b132ec8481e2c5b835663fbed3bbb93b5a747cf8776efe85650e29a8e5f0a63906480e5b9e5a9860bef703234812ce9f65ea6dcbc099ac952d1c36338e2d192a793b82a1d8a2dd6dd031f831c08805a9e7ea1f55d46c54cf6ecaecbac84ddf581c8a267a116c0d6d935f19171bce93c6e040c0bd49fc1325bdb8929914548d7c0cae78796aba4073dc9ab63194a90e430919d8757c7ccb7b4dffc61b9cd4a748edc88d0b4ba727c83ea1af546908ff63a1e2ee9784a7b9af2f61997e0dd34adcb479151d11d0e8d67ba76050d55c7bbb88f2f700e14f848f6b929b441869fba53436eb7983660d0e4af82aa0dc5c47dddf974599280179889c03c3e38212eaa8270c641298f0a49b923ed3d04d61e2c6c25844b67df9e4814d378b440e8124e429dc292a147038a57c03e8b8ece700b376fcf8e002dca35142f97b5f49144e2f7477b99d767dff12bb37dd846419051bdaa4c6d931545a5df09bda8a80a336585e5d6ba44f087607512344f91321a359dc150cb411600fbf0d974f63116046d681d3f82a16e50e3bb69c463430e284f64e007f354a9ed4a2afdb27caad0414d451875ec78ea98924e32d8f881eb2c260b348e00baf782",
"key": "postman.sid"
}
],
"body": "{\n \"monitor\": {\n \"id\": \"1e6b6cc1-c760-48e0-968f-4bfaeeae9af1\",\n \"name\": \"Postman Echo Monitor\",\n \"uid\": \"5852-1e6b6cc1-c760-48e0-968f-4bfaeeae9af1\",\n \"owner\": \"5852\",\n \"collectionUid\": \"5852-8d05dd85-222c-1452-553b-e76a531b71ed\",\n \"environmentUid\": \"5851-8d05dd85-222c-1452-553b-e76a531b71ed\",\n \"options\": {\n \"strictSSL\": true,\n \"followRedirects\": true,\n \"requestTimeout\": 3000,\n \"requestDelay\": 0\n },\n \"notifications\": {\n \"onError\": [\n {\n \"email\": \"john.appleseed@example.com\"\n }\n ],\n \"onFailure\": [\n {\n \"email\": \"john.appleseed@example.com\"\n }\n ]\n },\n \"distribution\": [],\n \"schedule\": {\n \"cron\": \"0 0 * * * *\",\n \"timezone\": \"Asia/Calcutta\",\n \"nextRun\": \"2016-11-30T09:30:00.000Z\"\n },\n \"lastRun\": {\n \"status\": \"failed\",\n \"startedAt\": \"2020-03-25T15:45:29.218Z\",\n \"finishedAt\": \"2020-03-25T15:45:31.340Z\",\n \"stats\": {\n \"assertions\": {\n \"total\": 8,\n \"failed\": 1\n },\n \"requests\": {\n \"total\": 4\n }\n }\n }\n }\n}"
}
]
}
