Chilkat Online Tools

unicodeCpp / Zoom API / Get operation logs report

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttpW http;
    bool success;

    CkJsonObjectW queryParams;
    queryParams.UpdateString(L"from",L"1989-05-07");
    queryParams.UpdateString(L"to",L"1989-05-07");
    queryParams.UpdateInt(L"page_size",30);
    queryParams.UpdateString(L"next_page_token",L"quis officia in reprehenderit");
    queryParams.UpdateString(L"category_type",L"all");

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken(L"<access_token>");

    CkHttpResponseW *resp = http.QuickRequestParams(L"GET",L"https://api.zoom.us/v2/report/operationlogs",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkStringBuilderW sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = resp->get_StatusCode();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",resp->header());
        wprintf(L"Failed.\n");
        delete resp;
        return;
    }

    delete resp;

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const wchar_t *time = 0;
    const wchar_t *operator = 0;
    const wchar_t *category_type = 0;
    const wchar_t *action = 0;
    const wchar_t *operation_detail = 0;

    const wchar_t *from = jResp.stringOf(L"from");
    const wchar_t *v_to = jResp.stringOf(L"to");
    int page_size = jResp.IntOf(L"page_size");
    const wchar_t *next_page_token = jResp.stringOf(L"next_page_token");
    int i = 0;
    int count_i = jResp.SizeOfArray(L"operation_logs");
    while (i < count_i) {
        jResp.put_I(i);
        time = jResp.stringOf(L"operation_logs[i].time");
        operator = jResp.stringOf(L"operation_logs[i].operator");
        category_type = jResp.stringOf(L"operation_logs[i].category_type");
        action = jResp.stringOf(L"operation_logs[i].action");
        operation_detail = jResp.stringOf(L"operation_logs[i].operation_detail");
        i = i + 1;
    }
    }

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": ""
    }
  ]
}