Genesys Cloud - Developer Community!

 View Only

Sign Up

Expand all | Collapse all

Agent Copilot Summary Analytics API

  • 1.  Agent Copilot Summary Analytics API

    Posted 06-20-2025 00:32

    Hi everyone,

    In this week's release notes, there's a mention of the Agent Copilot Summary Analytics API, but I'm not sure which API it refers to.

    I've tried a POST request to:
    /api/v2/analytics/agentcopilots/aggregates/query

    and also checked the preview APIs, but I couldn't find the Analytics API mentioned in the release notes

    Can anyone clarify where I can access the API that provides these metrics related to summaries?

    Thanks in advance!


    #PlatformAPI

    ------------------------------
    Ramsha Shaikh
    Telecom/AI Engineer
    ------------------------------


  • 2.  RE: Agent Copilot Summary Analytics API

    Posted 06-25-2025 11:05

    You should find 2

    https://developer.genesys.cloud/devapps/api-explorer#post-api-v2-analytics-summaries-aggregates-query

    This is updated to show metrics on summaries as mentioned in the release note.

    Second is from the conversation set that is also covered there

    https://developer.genesys.cloud/devapps/api-explorer#get-api-v2-conversations--conversationId--summaries

    We will raise a request to update the docs to be more obvious.



    ------------------------------
    Marc Sassoon
    Digital & AI Technical Specialist
    Genesys - Employees
    marc.sassoon@genesys.com
    ------------------------------



  • 3.  RE: Agent Copilot Summary Analytics API

    Posted 06-25-2025 11:06

    Hi Ramsha,

    The summary analytics API are in the analytics section: https://developer.genesys.cloud/analyticsdatamanagement/analytics/aggregate/summary-query

    You should be able to find what you're looking for on that link.

    Thanks,

    Amanda Halpin



    ------------------------------
    Amanda Halpin
    EMEA Strategic Solutions Lead
    ------------------------------



  • 4.  RE: Agent Copilot Summary Analytics API

    Posted 06-26-2025 02:13

    Hi Amanda and Marc,

    Thank you for the information.

    When I attempt to query the API endpoint /api/v2/analytics/summaries/aggregates/query, I receive the following error:

    "Unable to perform the requested action. You must have at least one of the following permissions assigned: [analytics:summaryAggregate:view]"

    I wanted to check whether enabling this permission and querying this API incurs any additional costs or token usage.



    ------------------------------
    Ramsha Shaikh
    Telecom/AI Engineer
    ------------------------------



  • 5.  RE: Agent Copilot Summary Analytics API

    Posted 06-26-2025 04:10

    Hi Ramsha,

    There's no additional cost associated with that permission.

    Thanks,

    Amanda



    ------------------------------
    Amanda Halpin
    EMEA Strategic Solutions Lead
    ------------------------------



  • 6.  RE: Agent Copilot Summary Analytics API

    Posted 06-26-2025 04:20

    This helps, thank you!

    Just one more question. I tried the following query in the API Explorer, but it returns {}.

    {
      "interval": "2025-04-30T18:30:00.000Z/2025-05-30T18:30:00.000Z",
      "metrics": [
        "nConversationSummaries",
        "nConversationSummaryEngagements",
        "tConversationSummary"
      ],
      "filter": {
        "type": "and",
        "predicates": [
          {
            "type": "dimension",
            "dimension": "triggerSourceType",
            "operator": "matches",
            "value": "COPILOT"
          },
          {
            "type": "dimension",
            "dimension": "copied",
            "operator": "matches",
            "value": "true"
          }
        ]
      }
    }


    Could this be because Summary Engagements is still in preview?

    All other queries, like those under Summary Generation, seem to work fine, but anything from Summary Engagement Queries returns an empty response.

    Appreciate your help!



    ------------------------------
    Ramsha Shaikh
    Telecom/AI Engineer
    ------------------------------



  • 7.  RE: Agent Copilot Summary Analytics API

    Posted 06-26-2025 04:26

    Hi Ramsha,

    Summaries are stored for 10 days so the API call isn't working because your date range is beyond that. 

    If you change the date range it should work as expected.

    Thanks,

    Amanda



    ------------------------------
    Amanda Halpin
    EMEA Strategic Solutions Lead
    ------------------------------



  • 8.  RE: Agent Copilot Summary Analytics API

    Posted 06-26-2025 04:34

    Got it, thanks for clarifying.



    ------------------------------
    Ramsha Shaikh
    Telecom/AI Engineer
    ------------------------------



  • 9.  RE: Agent Copilot Summary Analytics API

    Posted 06-26-2025 04:58

    Hi Amanda,

    Quick follow-up. I see that the stats count for nConversationSummaryEngagements is being returned for the interval 20th June to 24th June.

    "interval": "2025-06-20T18:30:00.000Z/2025-06-24T18:29:59.000Z",
    "metrics": [
      {
        "metric": "nConversationSummaryEngagements",
        "stats": {
          "count": 34070
        }
      }
    ]

    However, when I apply filters to the Summary Engagement query using dimensions like copied, summaryRating, or editedField, the API returns an empty result {}. For instance, here are the queries I tried:

    {
      "metrics": ["nConversationSummaryEngagements"],
      "filter": {
        "type": "and",
        "predicates": [
          {
            "type": "dimension",
            "dimension": "triggerSourceType",
            "operator": "matches",
            "value": "COPILOT"
          },
          {
            "type": "dimension",
            "dimension": "summaryRating",
            "operator": "matches",
            "value": "POSITIVE"
          }
        ]
      },
      "interval": "2025-06-20T18:30:00.000Z/2025-06-24T18:29:59.000Z"
    }

    {
      "metrics": [
        "nConversationSummaryEngagements"
      ],
      "filter": {
        "type": "and",
        "predicates": [
          {
            "type": "dimension",
            "dimension": "triggerSourceType",
            "operator": "matches",
            "value": "COPILOT"
          },
          {
            "type": "dimension",
            "dimension": "editedField",
            "operator": "matches",
            "value": "SUMMARY"
          }
        ]
      },
      "interval": "2025-06-20T18:30:00.000Z/2025-06-24T18:29:59.000Z"
    }

    {
      "metrics": [
        "nConversationSummaryEngagements"
      ],
      "filter": {
        "type": "and",
        "predicates": [
          {
            "type": "dimension",
            "dimension": "triggerSourceType",
            "operator": "matches",
            "value": "COPILOT"
          },
          {
            "type": "dimension",
            "dimension": "copied",
            "operator": "matches",
            "value": "true"
          }
        ]
      },
      "interval": "2025-06-20T18:30:00.000Z/2025-06-24T18:29:59.000Z"
    }

    Am I missing something in how I'm constructing the filter? or if there's a specific way these dimensions should be used?

    Appreciate your help, Thanks in advance!



    ------------------------------
    Ramsha Shaikh
    Telecom/AI Engineer
    ------------------------------



  • 10.  RE: Agent Copilot Summary Analytics API

    Posted 06-26-2025 05:25

    Hey Ramsha,

    I've double checked and the TTL of 10 days shouldn't impact the analytics so I want to troubleshoot this a bit further. Is it ok if I email you to get some further details?

    Thanks,

    Amanda



    ------------------------------
    Amanda Halpin
    EMEA Strategic Solutions Lead
    ------------------------------



  • 11.  RE: Agent Copilot Summary Analytics API

    Posted 06-26-2025 05:28

    Definitely!



    ------------------------------
    Ramsha Shaikh
    Telecom/AI Engineer
    ------------------------------