I have been exploring through the API and am seeking a little more information. As an admin user I am able to view a table in the performance tab that has information on all agent. I am trying to use the API to get the information I see in the table. Just some example of the columns I see are "Interval Start", "Interval End", "Interval Complete" ,"Filters", "Media Type"," Agent Id", "Agent Name" and others...
Is there a route I missed in the documentation that I can use to get the information similar to what I see in the performance tab? Let me know if there is more information I can provide!
Hello, you can find documentation for each of the performance views here: About reports, views, and dashboards - Genesys Cloud Resource Center. Each view has explanations of each column it includes. There's not a 1:1 mapping between any view and an API endpoint. You'll typically obtain the data you require by analyzing/aggregating information from analytics queries and resolving entity references as necessary (e.g. resolve a user's GUID to a display name).
Thank you for the information Tim. Just to clarify I am using the .net package and calling the GetAnalyticsReportingExportsMetadata() function. This returns entities with column names like "agent_status_meal", "agent_status_system_away". There are many other columns. So I will have to provide a job id, agent id and a date range to the api and manipulate the data on my side? Do you know where in the admin pages I can find job ids? I can see ids for my agents, but not job ids.
I'm not sure what job id you're referring to or what data you're trying to manipulate. Can you be more specific about which API endpoint you're trying to use?
Posting an example of what I am working with.
var analyticsApi = new AnalyticsApi();
var resp = apiInstance.GetAnalyticsUsersDetailsJob("JobID ");
I am looking to get a response by changing "JobID" to a job id we have, but I am not able to find that value...
I did something similar to this with the UsersApi and was able to provide a user id into the function to retrieve data.
Just to clarify, there is no api call that retrieves the data from a table export that gets sent to an email address?
I think there is maybe a misunderstanding on this.
The principle of jobs (async queries) is that it is 3 step process.
You perform a request to create an async job/query (1st API endpoint) -> gives you back a jobId
You poll the system waiting for the job to complete (2nd API endpoint) -> gives you back a status for the job
When the job is FULFILLED, you can start retrieving results (3rd API endpoint).
Thank you for the information. I am still reading through the information provided. Is there a way to get the information for an Agent's performance for a certain time range via API?
The table I am looking at is under this URL regionurl/directory/#/analytics/agents/performance
The requests (API endpoints) used in the Performance Views are not documented. These API endpoints are the standard ones from the Platform API.
The only thing I can advise you to do if you want to understand what requests are generated to build a performance view is to have check the Network logs in your browser (e.g. with Chrome - displaying Developer Tools - and checking Network tab to see the HTTP request).