genesys-analytics - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /genesys-analytics | Type: Application | PCID required: Yes

Tools

Tool	Description
`genesys_analytics_delete_conversations_details_job`	Delete/cancel an async details job
`genesys_analytics_delete_users_details_job`	Delete/cancel an async request
`genesys_analytics_get_agent_status`	Get an agent and their active sessions by user ID
`genesys_analytics_get_analytics_agent_status`	Get an agent and their active sessions by user ID
`genesys_analytics_get_analytics_conversation_details`	Get a conversation by id
`genesys_analytics_get_analytics_conversations_details`	Gets multiple conversations by id
`genesys_analytics_get_botflow_divisions_reportingturns`	Get Reporting Turns (division aware).
`genesys_analytics_get_botflow_sessions`	Get Bot Flow Sessions.
`genesys_analytics_get_conversations_details_job`	Get status for async query for conversation details
`genesys_analytics_get_users_details_job`	Get status for async query for user details
`genesys_analytics_get_users_details_job_results`	Fetch a page of results for an async query
`genesys_analytics_post_actions_aggregates_query`	Query for action aggregates
`genesys_analytics_post_agentcopilots_aggregates_query`	Query for agent copilot aggregates
`genesys_analytics_post_agents_status_counts`	Count agents by different groupings
`genesys_analytics_post_agents_status_query`	Retrieve the top 50 agents matching the query filters
`genesys_analytics_post_analytics_agents_status_counts`	Count agents by different groupings
`genesys_analytics_post_analytics_agents_status_query`	Retrieve the top 50 agents matching the query filters
`genesys_analytics_post_analytics_conversations_activity_query`	Query for conversation activity observations
`genesys_analytics_post_analytics_evaluations_aggregates_query`	Query for evaluation aggregates
`genesys_analytics_post_analytics_surveys_aggregates_query`	Query for survey aggregates
`genesys_analytics_post_analytics_users_activity_query`	Query for user activity observations
`genesys_analytics_post_analytics_users_aggregates_query`	Query for user aggregates
`genesys_analytics_post_analytics_users_details_query`	Query for user details
`genesys_analytics_post_analytics_users_observations_query`	Query for user observations
`genesys_analytics_post_bots_aggregates_query`	Query for bot aggregates
`genesys_analytics_post_conversation_details_properties`	Index conversation properties
`genesys_analytics_post_conversations_details_jobs`	Query for conversation details asynchronously
`genesys_analytics_post_evaluations_aggregates_query`	Query for evaluation aggregates
`genesys_analytics_post_flowexecutions_aggregates_query`	Query for flow execution aggregates
`genesys_analytics_post_flows_activity_query`	Query for flow activity observations
`genesys_analytics_post_flows_aggregates_query`	Query for flow aggregates
`genesys_analytics_post_flows_observations_query`	Query for flow observations
`genesys_analytics_post_journeys_aggregates_query`	Query for journey aggregates
`genesys_analytics_post_knowledge_aggregates_query`	Query for knowledge aggregates
`genesys_analytics_post_queues_observations_query`	Query for queue observations
`genesys_analytics_post_ratelimits_aggregates_query`	Query for limits rate limit aggregates. Data populated when limits reach 90% of the maximum. Not a source of truth for limits hit but a best effort estimate.
`genesys_analytics_post_resolutions_aggregates_query`	Query for resolution aggregates
`genesys_analytics_post_routing_activity_query`	Query for user activity observations
`genesys_analytics_post_summaries_aggregates_query`	Query for summary aggregates
`genesys_analytics_post_surveys_aggregates_query`	Query for survey aggregates
`genesys_analytics_post_taskmanagement_aggregates_query`	Query for task management aggregates
`genesys_analytics_post_teams_activity_query`	Query for team activity observations
`genesys_analytics_post_transcripts_aggregates_query`	Query for transcript aggregates
`genesys_analytics_post_users_activity_query`	Query for user activity observations
`genesys_analytics_post_users_aggregates_query`	Query for user aggregates
`genesys_analytics_post_users_details_jobs`	Query for user details asynchronously
`genesys_analytics_post_users_details_query`	Query for user details
`genesys_analytics_post_users_observations_query`	Query for user observations

genesys_analytics_delete_conversations_details_job

Delete/cancel an async details job Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	jobId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "jobId"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

genesys_analytics_delete_users_details_job

Delete/cancel an async request Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	jobId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "jobId"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

genesys_analytics_get_agent_status

Get an agent and their active sessions by user ID Parameters:

Parameter	Type	Required	Default	Description
`userId`	string	Yes	—	userId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "userId"
    }
  },
  "required": [
    "PCID",
    "userId"
  ]
}

genesys_analytics_get_analytics_agent_status

Get an agent and their active sessions by user ID Parameters:

Parameter	Type	Required	Default	Description
`userId`	string	Yes	—	userId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "userId"
    }
  },
  "required": [
    "PCID",
    "userId"
  ]
}

genesys_analytics_get_analytics_conversation_details

Get a conversation by id Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversationId"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_analytics_get_analytics_conversations_details

Gets multiple conversations by id Parameters:

Parameter	Type	Required	Default	Description
`id`	any[]	No	—	Comma-separated conversation ids

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "array",
      "description": "Comma-separated conversation ids"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_analytics_get_botflow_divisions_reportingturns

Get Reporting Turns (division aware). Parameters:

Parameter	Type	Required	Default	Description
`botFlowId`	string	Yes	—	ID of the bot flow.
`after`	string	No	—	The cursor that points to the ID of the last item in the list of entities that has been returned.
`pageSize`	string	No	—	Max number of entities to return. Maximum of 250
`interval`	string	No	—	Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: ‘2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07’. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`actionId`	string	No	—	Optional action ID to get the reporting turns associated to a particular flow action
`sessionId`	string	No	—	Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.
`language`	string	No	—	Optional language code to get the reporting turns for a particular language
`askActionResults`	string	No	—	Optional case-insensitive comma separated list of ask action results to filter the reporting turns.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "botFlowId": {
      "type": "string",
      "description": "ID of the bot flow."
    },
    "after": {
      "type": "string",
      "description": "The cursor that points to the ID of the last item in the list of entities that has been returned."
    },
    "pageSize": {
      "type": "string",
      "description": "Max number of entities to return. Maximum of 250"
    },
    "interval": {
      "type": "string",
      "description": "Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "actionId": {
      "type": "string",
      "description": "Optional action ID to get the reporting turns associated to a particular flow action"
    },
    "sessionId": {
      "type": "string",
      "description": "Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed."
    },
    "language": {
      "type": "string",
      "description": "Optional language code to get the reporting turns for a particular language"
    },
    "askActionResults": {
      "type": "string",
      "description": "Optional case-insensitive comma separated list of ask action results to filter the reporting turns.",
      "enum": [
        "AgentRequestedByUser",
        "ConfirmationRequired",
        "DisambiguationRequired",
        "Error",
        "ExpressionError",
        "NoInputCollection",
        "NoInputConfirmation",
        "NoInputDisambiguation",
        "NoMatchCollection",
        "NoMatchConfirmation",
        "NoMatchDisambiguation",
        "SuccessCollection",
        "SkippedCollection",
        "SuccessConfirmationNo",
        "SuccessConfirmationYes",
        "SuccessDisambiguation",
        "SuccessDisambiguationNone",
        "GuardrailsViolation"
      ]
    }
  },
  "required": [
    "PCID",
    "botFlowId"
  ]
}

genesys_analytics_get_botflow_sessions

Get Bot Flow Sessions. Parameters:

Parameter	Type	Required	Default	Description
`botFlowId`	string	Yes	—	ID of the bot flow.
`after`	string	No	—	The cursor that points to the ID of the last item in the list of entities that has been returned.
`pageSize`	string	No	—	Max number of entities to return. Maximum of 250
`interval`	string	No	—	Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: ‘2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07’. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`botResultCategories`	string	No	—	Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by.
`endLanguage`	string	No	—	Optional case-insensitive language code to filter sessions by the language the sessions ended in.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "botFlowId": {
      "type": "string",
      "description": "ID of the bot flow."
    },
    "after": {
      "type": "string",
      "description": "The cursor that points to the ID of the last item in the list of entities that has been returned."
    },
    "pageSize": {
      "type": "string",
      "description": "Max number of entities to return. Maximum of 250"
    },
    "interval": {
      "type": "string",
      "description": "Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "botResultCategories": {
      "type": "string",
      "description": "Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by.",
      "enum": [
        "Unknown",
        "UserExit",
        "BotExit",
        "Error",
        "RecognitionFailure",
        "UserDisconnect",
        "BotDisconnect",
        "SessionExpired",
        "Transfer"
      ]
    },
    "endLanguage": {
      "type": "string",
      "description": "Optional case-insensitive language code to filter sessions by the language the sessions ended in."
    }
  },
  "required": [
    "PCID",
    "botFlowId"
  ]
}

genesys_analytics_get_conversations_details_job

Get status for async query for conversation details Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	jobId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "jobId"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

genesys_analytics_get_users_details_job

Get status for async query for user details Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	jobId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "jobId"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

genesys_analytics_get_users_details_job_results

Fetch a page of results for an async query Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	jobId
`cursor`	string	No	—	Indicates where to resume query results (not required for first page)
`pageSize`	integer	No	—	The desired maximum number of results

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "jobId"
    },
    "cursor": {
      "type": "string",
      "description": "Indicates where to resume query results (not required for first page)"
    },
    "pageSize": {
      "type": "integer",
      "description": "The desired maximum number of results"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

genesys_analytics_post_actions_aggregates_query

Query for action aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_agentcopilots_aggregates_query

Query for agent copilot aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`limit`	integer	No	—	How many results you want in an ordered list. Only applicable for topN/bottomN query type.
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`queryType`	string	No	—	Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
`sortMetric`	object	No	—	sortMetric
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "limit": {
      "type": "integer",
      "description": "How many results you want in an ordered list. Only applicable for topN/bottomN query type."
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "queryType": {
      "type": "string",
      "description": "Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.",
      "enum": [
        "bottomN",
        "groupBy",
        "topN"
      ]
    },
    "sortMetric": {
      "type": "object",
      "description": "sortMetric"
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_agents_status_counts

Count agents by different groupings Parameters:

Parameter	Type	Required	Default	Description
`groupBy`	any[]	No	—	Include to choose which groupings to count by and return. If not included it will return only counts grouped by segmentType
`sessionFilter`	object	No	—	sessionFilter
`userFilter`	object	No	—	userFilter

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "groupBy": {
      "type": "array",
      "description": "Include to choose which groupings to count by and return. If not included it will return only counts grouped by segmentType"
    },
    "sessionFilter": {
      "type": "object",
      "description": "sessionFilter"
    },
    "userFilter": {
      "type": "object",
      "description": "userFilter"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_analytics_post_agents_status_query

Retrieve the top 50 agents matching the query filters Parameters:

Parameter	Type	Required	Default	Description
`sessionFilter`	object	No	—	sessionFilter
`sessionOrder`	string	No	—	Search session order direction; default to asc
`sessionOrderBy`	string	No	—	Search session order dimension names; default to segmentStart
`userFilter`	object	No	—	userFilter
`userOrder`	string	No	—	Search user order direction; default to asc
`userOrderBy`	string	No	—	Search user order dimension names; default to userName

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sessionFilter": {
      "type": "object",
      "description": "sessionFilter"
    },
    "sessionOrder": {
      "type": "string",
      "description": "Search session order direction; default to asc",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "sessionOrderBy": {
      "type": "string",
      "description": "Search session order dimension names; default to segmentStart",
      "enum": [
        "segmentStart",
        "sessionStart"
      ]
    },
    "userFilter": {
      "type": "object",
      "description": "userFilter"
    },
    "userOrder": {
      "type": "string",
      "description": "Search user order direction; default to asc",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "userOrderBy": {
      "type": "string",
      "description": "Search user order dimension names; default to userName",
      "enum": [
        "userName",
        "segmentStart",
        "sessionStart",
        "presenceDate",
        "routingStatusDate",
        "systemPresence",
        "routingStatus",
        "organizationPresenceId"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_analytics_post_analytics_agents_status_counts

Count agents by different groupings Parameters:

Parameter	Type	Required	Default	Description
`groupBy`	any[]	No	—	Include to choose which groupings to count by and return. If not included it will return only counts grouped by segmentType
`sessionFilter`	object	No	—	sessionFilter
`userFilter`	object	No	—	userFilter

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "groupBy": {
      "type": "array",
      "description": "Include to choose which groupings to count by and return. If not included it will return only counts grouped by segmentType"
    },
    "sessionFilter": {
      "type": "object",
      "description": "sessionFilter"
    },
    "userFilter": {
      "type": "object",
      "description": "userFilter"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_analytics_post_analytics_agents_status_query

Retrieve the top 50 agents matching the query filters Parameters:

Parameter	Type	Required	Default	Description
`sessionFilter`	object	No	—	sessionFilter
`sessionOrder`	string	No	—	Search session order direction; default to asc
`sessionOrderBy`	string	No	—	Search session order dimension names; default to segmentStart
`userFilter`	object	No	—	userFilter
`userOrder`	string	No	—	Search user order direction; default to asc
`userOrderBy`	string	No	—	Search user order dimension names; default to userName

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "sessionFilter": {
      "type": "object",
      "description": "sessionFilter"
    },
    "sessionOrder": {
      "type": "string",
      "description": "Search session order direction; default to asc",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "sessionOrderBy": {
      "type": "string",
      "description": "Search session order dimension names; default to segmentStart",
      "enum": [
        "segmentStart",
        "sessionStart"
      ]
    },
    "userFilter": {
      "type": "object",
      "description": "userFilter"
    },
    "userOrder": {
      "type": "string",
      "description": "Search user order direction; default to asc",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "userOrderBy": {
      "type": "string",
      "description": "Search user order dimension names; default to userName",
      "enum": [
        "userName",
        "segmentStart",
        "sessionStart",
        "presenceDate",
        "routingStatusDate",
        "systemPresence",
        "routingStatus",
        "organizationPresenceId"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_analytics_post_analytics_conversations_activity_query

Query for conversation activity observations Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	The desired page size
`pageNumber`	integer	No	—	The desired page number
`filter`	object	No	—	filter
`groupBy`	any[]	Yes	—	Dimension(s) to group by
`metrics`	any[]	Yes	—	List of requested metrics
`order`	string	No	—	Sort the result set in ascending/descending order. Default is ascending

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "The desired page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The desired page number"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "groupBy": {
      "type": "array",
      "description": "Dimension(s) to group by"
    },
    "metrics": {
      "type": "array",
      "description": "List of requested metrics"
    },
    "order": {
      "type": "string",
      "description": "Sort the result set in ascending/descending order. Default is ascending",
      "enum": [
        "asc",
        "desc",
        "unordered"
      ]
    }
  },
  "required": [
    "PCID",
    "groupBy",
    "metrics"
  ]
}

genesys_analytics_post_analytics_evaluations_aggregates_query

Query for evaluation aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "conversationStart",
        "evaluationCreatedDate",
        "evaluationReleaseDate",
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_analytics_surveys_aggregates_query

Query for survey aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime",
        "surveyCreatedDate"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_analytics_users_activity_query

Query for user activity observations Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	The desired page size
`pageNumber`	integer	No	—	The desired page number
`filter`	object	No	—	filter
`groupBy`	any[]	Yes	—	Dimension(s) to group by
`metrics`	any[]	Yes	—	List of requested metrics
`order`	string	No	—	Sort the result set in ascending/descending order. Default is ascending

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "The desired page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The desired page number"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "groupBy": {
      "type": "array",
      "description": "Dimension(s) to group by"
    },
    "metrics": {
      "type": "array",
      "description": "List of requested metrics"
    },
    "order": {
      "type": "string",
      "description": "Sort the result set in ascending/descending order. Default is ascending",
      "enum": [
        "asc",
        "desc",
        "unordered"
      ]
    }
  },
  "required": [
    "PCID",
    "groupBy",
    "metrics"
  ]
}

genesys_analytics_post_analytics_users_aggregates_query

Query for user aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_analytics_users_details_query

Query for user details Parameters:

Parameter	Type	Required	Default	Description
`interval`	string	Yes	—	Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`order`	string	No	—	Sort the result set in ascending/descending order. Default is ascending
`paging`	object	No	—	paging
`presenceAggregations`	any[]	No	—	Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters
`presenceFilters`	any[]	No	—	Filters that target system and organization presence-level data
`routingStatusAggregations`	any[]	No	—	Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters
`routingStatusFilters`	any[]	No	—	Filters that target agent routing status-level data
`userFilters`	any[]	No	—	Filters that target the users to retrieve data for

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "interval": {
      "type": "string",
      "description": "Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "order": {
      "type": "string",
      "description": "Sort the result set in ascending/descending order. Default is ascending",
      "enum": [
        "asc",
        "desc",
        "unordered"
      ]
    },
    "paging": {
      "type": "object",
      "description": "paging"
    },
    "presenceAggregations": {
      "type": "array",
      "description": "Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters"
    },
    "presenceFilters": {
      "type": "array",
      "description": "Filters that target system and organization presence-level data"
    },
    "routingStatusAggregations": {
      "type": "array",
      "description": "Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters"
    },
    "routingStatusFilters": {
      "type": "array",
      "description": "Filters that target agent routing status-level data"
    },
    "userFilters": {
      "type": "array",
      "description": "Filters that target the users to retrieve data for"
    }
  },
  "required": [
    "PCID",
    "interval"
  ]
}

genesys_analytics_post_analytics_users_observations_query

Query for user observations Parameters:

Parameter	Type	Required	Default	Description
`detailMetrics`	any[]	No	—	Metrics for which to include additional detailed observations
`filter`	object	Yes	—	filter
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "detailMetrics": {
      "type": "array",
      "description": "Metrics for which to include additional detailed observations"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    }
  },
  "required": [
    "PCID",
    "filter",
    "metrics"
  ]
}

genesys_analytics_post_bots_aggregates_query

Query for bot aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_conversation_details_properties

Index conversation properties Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`properties`	any[]	Yes	—	The list of properties to index
`sessionId`	string	Yes	—	Attach properties to a segment in the indicated session
`targetDate`	string	Yes	—	Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversationId"
    },
    "properties": {
      "type": "array",
      "description": "The list of properties to index"
    },
    "sessionId": {
      "type": "string",
      "description": "Attach properties to a segment in the indicated session"
    },
    "targetDate": {
      "type": "string",
      "description": "Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "properties",
    "sessionId",
    "targetDate"
  ]
}

genesys_analytics_post_conversations_details_jobs

Query for conversation details asynchronously Parameters:

Parameter	Type	Required	Default	Description
`conversationFilters`	any[]	No	—	Filters that target conversation-level data
`evaluationFilters`	any[]	No	—	Filters that target evaluations
`interval`	string	Yes	—	Specifies the date and time range of data being queried. Results will include all conversations that had activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`limit`	integer	No	—	Specify number of results to be returned
`order`	string	No	—	Sort the result set in ascending/descending order. Default is ascending
`orderBy`	string	No	—	Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart
`resolutionFilters`	any[]	No	—	Filters that target resolutions
`segmentFilters`	any[]	No	—	Filters that target individual segments within a conversation
`startOfDayIntervalMatching`	boolean	No	—	Add a filter to only include conversations that started after the beginning of the interval start date (UTC)
`surveyFilters`	any[]	No	—	Filters that target surveys

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationFilters": {
      "type": "array",
      "description": "Filters that target conversation-level data"
    },
    "evaluationFilters": {
      "type": "array",
      "description": "Filters that target evaluations"
    },
    "interval": {
      "type": "string",
      "description": "Specifies the date and time range of data being queried. Results will include all conversations that had activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "limit": {
      "type": "integer",
      "description": "Specify number of results to be returned"
    },
    "order": {
      "type": "string",
      "description": "Sort the result set in ascending/descending order. Default is ascending",
      "enum": [
        "asc",
        "desc",
        "unordered"
      ]
    },
    "orderBy": {
      "type": "string",
      "description": "Specify which data element within the result set to use for sorting. The options  to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart",
      "enum": [
        "conversationStart",
        "conversationEnd",
        "segmentStart",
        "segmentEnd"
      ]
    },
    "resolutionFilters": {
      "type": "array",
      "description": "Filters that target resolutions"
    },
    "segmentFilters": {
      "type": "array",
      "description": "Filters that target individual segments within a conversation"
    },
    "startOfDayIntervalMatching": {
      "type": "boolean",
      "description": "Add a filter to only include conversations that started after the beginning of the interval start date (UTC)"
    },
    "surveyFilters": {
      "type": "array",
      "description": "Filters that target surveys"
    }
  },
  "required": [
    "PCID",
    "interval"
  ]
}

genesys_analytics_post_evaluations_aggregates_query

Query for evaluation aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "conversationStart",
        "evaluationCreatedDate",
        "evaluationReleaseDate",
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_flowexecutions_aggregates_query

Query for flow execution aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_flows_activity_query

Query for flow activity observations Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	The desired page size
`pageNumber`	integer	No	—	The desired page number
`filter`	object	No	—	filter
`groupBy`	any[]	Yes	—	Dimension(s) to group by
`metrics`	any[]	Yes	—	List of requested metrics
`order`	string	No	—	Sort the result set in ascending/descending order. Default is ascending

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "The desired page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The desired page number"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "groupBy": {
      "type": "array",
      "description": "Dimension(s) to group by"
    },
    "metrics": {
      "type": "array",
      "description": "List of requested metrics"
    },
    "order": {
      "type": "string",
      "description": "Sort the result set in ascending/descending order. Default is ascending",
      "enum": [
        "asc",
        "desc",
        "unordered"
      ]
    }
  },
  "required": [
    "PCID",
    "groupBy",
    "metrics"
  ]
}

genesys_analytics_post_flows_aggregates_query

Query for flow aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_flows_observations_query

Query for flow observations Parameters:

Parameter	Type	Required	Default	Description
`detailMetrics`	any[]	No	—	Metrics for which to include additional detailed observations
`filter`	object	Yes	—	filter
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "detailMetrics": {
      "type": "array",
      "description": "Metrics for which to include additional detailed observations"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    }
  },
  "required": [
    "PCID",
    "filter",
    "metrics"
  ]
}

genesys_analytics_post_journeys_aggregates_query

Query for journey aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_knowledge_aggregates_query

Query for knowledge aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`limit`	integer	No	—	How many results you want in an ordered list. Only applicable for topN/bottomN query type.
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`queryType`	string	No	—	Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
`sortMetric`	object	No	—	sortMetric
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "limit": {
      "type": "integer",
      "description": "How many results you want in an ordered list. Only applicable for topN/bottomN query type."
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "queryType": {
      "type": "string",
      "description": "Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.",
      "enum": [
        "bottomN",
        "groupBy",
        "topN"
      ]
    },
    "sortMetric": {
      "type": "object",
      "description": "sortMetric"
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_queues_observations_query

Query for queue observations Parameters:

Parameter	Type	Required	Default	Description
`detailMetrics`	any[]	No	—	Metrics for which to include additional detailed observations
`filter`	object	Yes	—	filter
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "detailMetrics": {
      "type": "array",
      "description": "Metrics for which to include additional detailed observations"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    }
  },
  "required": [
    "PCID",
    "filter",
    "metrics"
  ]
}

genesys_analytics_post_ratelimits_aggregates_query

Query for limits rate limit aggregates. Data populated when limits reach 90% of the maximum. Not a source of truth for limits hit but a best effort estimate. Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_resolutions_aggregates_query

Query for resolution aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event and choosing “wrapUpDate” uses the date when conversation is ended
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event and choosing \"wrapUpDate\" uses the date when conversation is ended",
      "enum": [
        "eventTime",
        "wrapUpDate"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_routing_activity_query

Query for user activity observations Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	The desired page size
`pageNumber`	integer	No	—	The desired page number
`filter`	object	No	—	filter
`groupBy`	any[]	Yes	—	Dimension(s) to group by
`metrics`	any[]	Yes	—	List of requested metrics
`order`	string	No	—	Sort the result set in ascending/descending order. Default is ascending

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "The desired page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The desired page number"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "groupBy": {
      "type": "array",
      "description": "Dimension(s) to group by"
    },
    "metrics": {
      "type": "array",
      "description": "List of requested metrics"
    },
    "order": {
      "type": "string",
      "description": "Sort the result set in ascending/descending order. Default is ascending",
      "enum": [
        "asc",
        "desc",
        "unordered"
      ]
    }
  },
  "required": [
    "PCID",
    "groupBy",
    "metrics"
  ]
}

genesys_analytics_post_summaries_aggregates_query

Query for summary aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`limit`	integer	No	—	How many results you want in an ordered list. Only applicable for topN/bottomN query type.
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`queryType`	string	No	—	Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.
`sortMetric`	object	No	—	sortMetric
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "limit": {
      "type": "integer",
      "description": "How many results you want in an ordered list. Only applicable for topN/bottomN query type."
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "queryType": {
      "type": "string",
      "description": "Query type to use. Use groupBy for all matching results, and topN/bottomN for N results ordered by the sortMetric. Default is groupBy.",
      "enum": [
        "bottomN",
        "groupBy",
        "topN"
      ]
    },
    "sortMetric": {
      "type": "object",
      "description": "sortMetric"
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_surveys_aggregates_query

Query for survey aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime",
        "surveyCreatedDate"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_taskmanagement_aggregates_query

Query for task management aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_teams_activity_query

Query for team activity observations Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	The desired page size
`pageNumber`	integer	No	—	The desired page number
`filter`	object	No	—	filter
`groupBy`	any[]	Yes	—	Dimension(s) to group by
`metrics`	any[]	Yes	—	List of requested metrics
`order`	string	No	—	Sort the result set in ascending/descending order. Default is ascending

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "The desired page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The desired page number"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "groupBy": {
      "type": "array",
      "description": "Dimension(s) to group by"
    },
    "metrics": {
      "type": "array",
      "description": "List of requested metrics"
    },
    "order": {
      "type": "string",
      "description": "Sort the result set in ascending/descending order. Default is ascending",
      "enum": [
        "asc",
        "desc",
        "unordered"
      ]
    }
  },
  "required": [
    "PCID",
    "groupBy",
    "metrics"
  ]
}

genesys_analytics_post_transcripts_aggregates_query

Query for transcript aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_users_activity_query

Query for user activity observations Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	The desired page size
`pageNumber`	integer	No	—	The desired page number
`filter`	object	No	—	filter
`groupBy`	any[]	Yes	—	Dimension(s) to group by
`metrics`	any[]	Yes	—	List of requested metrics
`order`	string	No	—	Sort the result set in ascending/descending order. Default is ascending

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "The desired page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The desired page number"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "groupBy": {
      "type": "array",
      "description": "Dimension(s) to group by"
    },
    "metrics": {
      "type": "array",
      "description": "List of requested metrics"
    },
    "order": {
      "type": "string",
      "description": "Sort the result set in ascending/descending order. Default is ascending",
      "enum": [
        "asc",
        "desc",
        "unordered"
      ]
    }
  },
  "required": [
    "PCID",
    "groupBy",
    "metrics"
  ]
}

genesys_analytics_post_users_aggregates_query

Query for user aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_analytics_post_users_details_jobs

Query for user details asynchronously Parameters:

Parameter	Type	Required	Default	Description
`interval`	string	Yes	—	Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`limit`	integer	No	—	Specify number of results to be returned
`order`	string	No	—	Sort the result set in ascending/descending order. Default is ascending
`presenceFilters`	any[]	No	—	Filters that target system and organization presence-level data
`routingStatusFilters`	any[]	No	—	Filters that target agent routing status-level data
`userFilters`	any[]	No	—	Filters that target the users to retrieve data for

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "interval": {
      "type": "string",
      "description": "Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "limit": {
      "type": "integer",
      "description": "Specify number of results to be returned"
    },
    "order": {
      "type": "string",
      "description": "Sort the result set in ascending/descending order. Default is ascending",
      "enum": [
        "asc",
        "desc",
        "unordered"
      ]
    },
    "presenceFilters": {
      "type": "array",
      "description": "Filters that target system and organization presence-level data"
    },
    "routingStatusFilters": {
      "type": "array",
      "description": "Filters that target agent routing status-level data"
    },
    "userFilters": {
      "type": "array",
      "description": "Filters that target the users to retrieve data for"
    }
  },
  "required": [
    "PCID",
    "interval"
  ]
}

genesys_analytics_post_users_details_query

Query for user details Parameters:

Parameter	Type	Required	Default	Description
`interval`	string	Yes	—	Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`order`	string	No	—	Sort the result set in ascending/descending order. Default is ascending
`paging`	object	No	—	paging
`presenceAggregations`	any[]	No	—	Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters
`presenceFilters`	any[]	No	—	Filters that target system and organization presence-level data
`routingStatusAggregations`	any[]	No	—	Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters
`routingStatusFilters`	any[]	No	—	Filters that target agent routing status-level data
`userFilters`	any[]	No	—	Filters that target the users to retrieve data for

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "interval": {
      "type": "string",
      "description": "Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "order": {
      "type": "string",
      "description": "Sort the result set in ascending/descending order. Default is ascending",
      "enum": [
        "asc",
        "desc",
        "unordered"
      ]
    },
    "paging": {
      "type": "object",
      "description": "paging"
    },
    "presenceAggregations": {
      "type": "array",
      "description": "Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters"
    },
    "presenceFilters": {
      "type": "array",
      "description": "Filters that target system and organization presence-level data"
    },
    "routingStatusAggregations": {
      "type": "array",
      "description": "Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters"
    },
    "routingStatusFilters": {
      "type": "array",
      "description": "Filters that target agent routing status-level data"
    },
    "userFilters": {
      "type": "array",
      "description": "Filters that target the users to retrieve data for"
    }
  },
  "required": [
    "PCID",
    "interval"
  ]
}

genesys_analytics_post_users_observations_query

Query for user observations Parameters:

Parameter	Type	Required	Default	Description
`detailMetrics`	any[]	No	—	Metrics for which to include additional detailed observations
`filter`	object	Yes	—	filter
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "detailMetrics": {
      "type": "array",
      "description": "Metrics for which to include additional detailed observations"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    }
  },
  "required": [
    "PCID",
    "filter",
    "metrics"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

​Tools

​genesys_analytics_delete_conversations_details_job

​genesys_analytics_delete_users_details_job

​genesys_analytics_get_agent_status

​genesys_analytics_get_analytics_agent_status

​genesys_analytics_get_analytics_conversation_details

​genesys_analytics_get_analytics_conversations_details

​genesys_analytics_get_botflow_divisions_reportingturns

​genesys_analytics_get_botflow_sessions

​genesys_analytics_get_conversations_details_job

​genesys_analytics_get_users_details_job

​genesys_analytics_get_users_details_job_results

​genesys_analytics_post_actions_aggregates_query

​genesys_analytics_post_agentcopilots_aggregates_query

​genesys_analytics_post_agents_status_counts

​genesys_analytics_post_agents_status_query

​genesys_analytics_post_analytics_agents_status_counts

​genesys_analytics_post_analytics_agents_status_query

​genesys_analytics_post_analytics_conversations_activity_query

​genesys_analytics_post_analytics_evaluations_aggregates_query

​genesys_analytics_post_analytics_surveys_aggregates_query

​genesys_analytics_post_analytics_users_activity_query

​genesys_analytics_post_analytics_users_aggregates_query

​genesys_analytics_post_analytics_users_details_query

​genesys_analytics_post_analytics_users_observations_query

​genesys_analytics_post_bots_aggregates_query

​genesys_analytics_post_conversation_details_properties

​genesys_analytics_post_conversations_details_jobs

​genesys_analytics_post_evaluations_aggregates_query

​genesys_analytics_post_flowexecutions_aggregates_query

​genesys_analytics_post_flows_activity_query

​genesys_analytics_post_flows_aggregates_query

​genesys_analytics_post_flows_observations_query

​genesys_analytics_post_journeys_aggregates_query

​genesys_analytics_post_knowledge_aggregates_query

​genesys_analytics_post_queues_observations_query

​genesys_analytics_post_ratelimits_aggregates_query

​genesys_analytics_post_resolutions_aggregates_query

​genesys_analytics_post_routing_activity_query

​genesys_analytics_post_summaries_aggregates_query

​genesys_analytics_post_surveys_aggregates_query

​genesys_analytics_post_taskmanagement_aggregates_query

​genesys_analytics_post_teams_activity_query

​genesys_analytics_post_transcripts_aggregates_query

​genesys_analytics_post_users_activity_query

​genesys_analytics_post_users_aggregates_query

​genesys_analytics_post_users_details_jobs

​genesys_analytics_post_users_details_query

​genesys_analytics_post_users_observations_query

Tools

genesys_analytics_delete_conversations_details_job

genesys_analytics_delete_users_details_job

genesys_analytics_get_agent_status

genesys_analytics_get_analytics_agent_status

genesys_analytics_get_analytics_conversation_details

genesys_analytics_get_analytics_conversations_details

genesys_analytics_get_botflow_divisions_reportingturns

genesys_analytics_get_botflow_sessions

genesys_analytics_get_conversations_details_job

genesys_analytics_get_users_details_job

genesys_analytics_get_users_details_job_results

genesys_analytics_post_actions_aggregates_query

genesys_analytics_post_agentcopilots_aggregates_query

genesys_analytics_post_agents_status_counts

genesys_analytics_post_agents_status_query

genesys_analytics_post_analytics_agents_status_counts

genesys_analytics_post_analytics_agents_status_query

genesys_analytics_post_analytics_conversations_activity_query

genesys_analytics_post_analytics_evaluations_aggregates_query

genesys_analytics_post_analytics_surveys_aggregates_query

genesys_analytics_post_analytics_users_activity_query

genesys_analytics_post_analytics_users_aggregates_query

genesys_analytics_post_analytics_users_details_query

genesys_analytics_post_analytics_users_observations_query

genesys_analytics_post_bots_aggregates_query

genesys_analytics_post_conversation_details_properties

genesys_analytics_post_conversations_details_jobs

genesys_analytics_post_evaluations_aggregates_query

genesys_analytics_post_flowexecutions_aggregates_query

genesys_analytics_post_flows_activity_query

genesys_analytics_post_flows_aggregates_query

genesys_analytics_post_flows_observations_query

genesys_analytics_post_journeys_aggregates_query

genesys_analytics_post_knowledge_aggregates_query

genesys_analytics_post_queues_observations_query

genesys_analytics_post_ratelimits_aggregates_query

genesys_analytics_post_resolutions_aggregates_query

genesys_analytics_post_routing_activity_query

genesys_analytics_post_summaries_aggregates_query

genesys_analytics_post_surveys_aggregates_query

genesys_analytics_post_taskmanagement_aggregates_query

genesys_analytics_post_teams_activity_query

genesys_analytics_post_transcripts_aggregates_query

genesys_analytics_post_users_activity_query

genesys_analytics_post_users_aggregates_query

genesys_analytics_post_users_details_jobs

genesys_analytics_post_users_details_query

genesys_analytics_post_users_observations_query