delphiAx / Zoom API / Get operation logs report
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
time: WideString;
operator: WideString;
category_type: WideString;
action: WideString;
operation_detail: WideString;
from: WideString;
v_to: WideString;
page_size: Integer;
next_page_token: WideString;
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 := TChilkatHttp.Create(Self);
queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('from','1989-05-07');
queryParams.UpdateString('to','1989-05-07');
queryParams.UpdateInt('page_size',30);
queryParams.UpdateString('next_page_token','quis officia in reprehenderit');
queryParams.UpdateString('category_type','all');
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
resp := http.QuickRequestParams('GET','https://api.zoom.us/v2/report/operationlogs',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "from": "2019-08-14",
// "to": "2019-09-14",
// "page_size": 30,
// "next_page_token": "czxcxdvxvddc",
// "operation_logs": [
// {
// "time": "2019-08-20T19:09:01Z",
// "operator": "someuser@sfksfhksdfsf.com",
// "category_type": "User",
// "action": "Update",
// "operation_detail": "Activate User sjkfhdsf@jdfgkhgd.com "
// },
// {
// "time": "2019-08-20T18:59:56Z",
// "operator": "anotheruser@sfhidshfidshufds.com",
// "category_type": "User",
// "action": "Update",
// "operation_detail": "Deactivate User mynewemail@jdfkdshfhjdsf.ffasdm "
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
from := jResp.StringOf('from');
v_to := jResp.StringOf('to');
page_size := jResp.IntOf('page_size');
next_page_token := jResp.StringOf('next_page_token');
i := 0;
count_i := jResp.SizeOfArray('operation_logs');
while i < count_i do
begin
jResp.I := i;
time := jResp.StringOf('operation_logs[i].time');
operator := jResp.StringOf('operation_logs[i].operator');
category_type := jResp.StringOf('operation_logs[i].category_type');
action := jResp.StringOf('operation_logs[i].action');
operation_detail := jResp.StringOf('operation_logs[i].operation_detail');
i := i + 1;
end;
Curl Command
curl -G -d "from=1989-05-07"
-d "to=1989-05-07"
-d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-d "category_type=all"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/report/operationlogs
Postman Collection Item JSON
{
"name": "Get operation logs report",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/report/operationlogs?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit&category_type=all",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"operationlogs"
],
"query": [
{
"key": "from",
"value": "1989-05-07",
"description": "(Required) Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once."
},
{
"key": "to",
"value": "1989-05-07",
"description": "(Required) End date."
},
{
"key": "page_size",
"value": "30",
"description": "The number of records returned within a single API call."
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"key": "category_type",
"value": "all",
"description": "**Optional**<br>\nFilter your response by a category type to see reports for a specific category.\nThe value for this field can be one of the following:<br> `all`<br>`user`<br>`user_settings`<br>`account`<br>`billing`<br>`im`<br>`recording`<br>`phone_contacts`<br>`webinar`<br>`sub_account`<br>`role`<br>`zoom_rooms`"
}
]
},
"description": "The [Operations Logs](https://support.zoom.us/hc/en-us/articles/360032748331-Operation-Logs) report allows you to audit admin and user activity, such as adding a new user, changing account settings, and deleting recordings.<br>\nUse this API to retrieve operation logs report for a specified period of time.<br>\n**Scopes:** `report:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n**Prerequisites:**<br>\n* Pro or higher plan."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nOperation Logs Report Returned",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/operationlogs?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit&category_type=all",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"operationlogs"
],
"query": [
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "category_type",
"value": "all"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"from\": \"2019-08-14\",\n \"to\": \"2019-09-14\",\n \"page_size\": 30,\n \"next_page_token\": \"czxcxdvxvddc\",\n \"operation_logs\": [\n {\n \"time\": \"2019-08-20T19:09:01Z\",\n \"operator\": \"someuser@sfksfhksdfsf.com\",\n \"category_type\": \"User\",\n \"action\": \"Update\",\n \"operation_detail\": \"Activate User sjkfhdsf@jdfgkhgd.com \"\n },\n {\n \"time\": \"2019-08-20T18:59:56Z\",\n \"operator\": \"anotheruser@sfhidshfidshufds.com\",\n \"category_type\": \"User\",\n \"action\": \"Update\",\n \"operation_detail\": \"Deactivate User mynewemail@jdfkdshfhjdsf.ffasdm \"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `300`<br>Only provide report in recent 6 months",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/operationlogs?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit&category_type=all",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"operationlogs"
],
"query": [
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "category_type",
"value": "all"
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
