Genesys Cloud - Developer Community!

 View Only

Sign Up

Information available in "/api/v2/audits/query"

  • 1.  Information available in "/api/v2/audits/query"

    Posted 04-02-2025 05:27

    Hi,
    I would be happy to receive an answer as I am in need of help.

    ##Overview.
    A customer has inquired about using the API to retrieve information when a report is exported to an email address.  

    ### Execute the query
    "/api/v2/audits/query" query API was used and the following query was defined  
     "AnalyticsReporting"-"entityType"-"Exports".  

    After executing the query and executing the obtained "transactionId" in "/api/v2/audits/query/{transactionId}/results", the following response was returned.

    ###API Response

    {
      "id": "9c49d4b6-cb49-4729-a148-d48ab47be7c0",
      "pageSize": 25,
      "entities": [
        {
          "id": "583cae9f-87d6-4bce-a5eb-6b133184405b",
          "userHomeOrgId": "f7110c89-35e5-4c11-b669-0ac7552cc6d0",
          "user": {
            "id": "11f27f54-e941-42dc-9319-107175e2190e",
            "selfUri": "/api/v2/users/11f27f54-e941-42dc-9319-107175e2190e"
          },
          "client": {
            "id": ""
          },
          "remoteIp": [
            "12.34.56.78"
          ],
          "serviceName": "AnalyticsReporting",
          "level": "USER",
          "eventDate": "2025-04-01T12:34:56Z",
          "action": "Create",
          "entity": {
            "id": "11f27f54-e941-42dc-9319-107175e2190e"
          },
          "entityType": "Exports",
          "status": "SUCCESS",
          "application": "",
          "initiatingAction": {},
          "transactionInitiator": false,
          "propertyChanges": [],
          "context": {
            "ExportType": "CSV",
            "HasEmail": "true"
          },
          "entityChanges": []
        }
      ]
    }

    ##Question.
    Could you please explain the following points regarding the above summary.

    1. "context.HasEmail" is set to "true", so we know that an e-mail was sent.
       How can I identify the destination of the sent e-mail?

    2. Please explain in detail about the "id" specified in "entity.id".
       What kind of information can be obtained by specifying "id"?

    Kind Regards,

    Kengo Koyama


    #PlatformAPI

    ------------------------------
    kengo koyama
    Staff
    ------------------------------