instruction
stringlengths 81
221
| input
stringlengths 50
1.19k
| output
stringlengths 525
3.61k
|
|---|---|---|
Provide a Python example that uses the GET /api/v2/assistants Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get all assistants. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentAssistantsApi();
before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional)
after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional)
limit = 'limit_example' # str | Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional)
page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional)
name = 'name_example' # str | Return the assistant by the given name. (optional)
try:
# Get all assistants.
api_response = api_instance.get_assistants(before=before, after=after, limit=limit, page_size=page_size, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentAssistantsApi->get_assistants: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/assistants Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create an Assistant. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentAssistantsApi();
body = PureCloudPlatformClientV2.Assistant() # Assistant |
try:
# Create an Assistant.
api_response = api_instance.post_assistants(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentAssistantsApi->post_assistants: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/assistants/queues Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get all queues assigned to any assistant. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentAssistantsApi();
before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional)
after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional)
page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional)
queue_ids = 'queue_ids_example' # str | Comma-separated identifiers of the queues that need to be retrieved. (optional)
expand = 'expand_example' # str | Which fields, if any, to expand. (optional)
try:
# Get all queues assigned to any assistant.
api_response = api_instance.get_assistants_queues(before=before, after=after, page_size=page_size, queue_ids=queue_ids, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentAssistantsApi->get_assistants_queues: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/assistants/{assistantId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete an assistant. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentAssistantsApi();
assistant_id = 'assistant_id_example' # str | Assistant ID
try:
# Delete an assistant.
api_instance.delete_assistant(assistant_id)
except ApiException as e:
print("Exception when calling AgentAssistantsApi->delete_assistant: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/assistants/{assistantId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get an assistant. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentAssistantsApi();
assistant_id = 'assistant_id_example' # str | Assistant ID
expand = 'expand_example' # str | Which fields, if any, to expand. (optional)
try:
# Get an assistant.
api_response = api_instance.get_assistant(assistant_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentAssistantsApi->get_assistant: %s\n" % e)``` |
Provide a Python example that uses the PATCH /api/v2/assistants/{assistantId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Update an assistant. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentAssistantsApi();
assistant_id = 'assistant_id_example' # str | Assistant ID
body = PureCloudPlatformClientV2.Assistant() # Assistant |
try:
# Update an assistant.
api_response = api_instance.patch_assistant(assistant_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentAssistantsApi->patch_assistant: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/assistants/{assistantId}/queues Genesys Cloud Python SDK. | Genesys describes this as an API used to: Disassociate the queues from an assistant for the given assistant ID and queue IDs. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentAssistantsApi();
assistant_id = 'assistant_id_example' # str | Assistant ID
queue_ids = 'queue_ids_example' # str | Comma-separated identifiers of the queues that need to be deleted. (optional)
try:
# Disassociate the queues from an assistant for the given assistant ID and queue IDs.
api_instance.delete_assistant_queues(assistant_id, queue_ids=queue_ids)
except ApiException as e:
print("Exception when calling AgentAssistantsApi->delete_assistant_queues: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/assistants/{assistantId}/queues Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get all the queues associated with an assistant. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentAssistantsApi();
assistant_id = 'assistant_id_example' # str | Assistant ID
before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional)
after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional)
page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional)
expand = 'expand_example' # str | Which fields, if any, to expand. (optional)
try:
# Get all the queues associated with an assistant.
api_response = api_instance.get_assistant_queues(assistant_id, before=before, after=after, page_size=page_size, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentAssistantsApi->get_assistant_queues: %s\n" % e)``` |
Provide a Python example that uses the PATCH /api/v2/assistants/{assistantId}/queues Genesys Cloud Python SDK. | Genesys describes this as an API used to: Update Queues for an Assistant. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentAssistantsApi();
assistant_id = 'assistant_id_example' # str | Assistant ID
body = [PureCloudPlatformClientV2.AssistantQueue()] # list[AssistantQueue] |
try:
# Update Queues for an Assistant.
api_response = api_instance.patch_assistant_queues(assistant_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentAssistantsApi->patch_assistant_queues: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/assistants/{assistantId}/queues/{queueId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Disassociate a queue from an assistant. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentAssistantsApi();
assistant_id = 'assistant_id_example' # str | Assistant ID
queue_id = 'queue_id_example' # str | Queue ID
try:
# Disassociate a queue from an assistant.
api_instance.delete_assistant_queue(assistant_id, queue_id)
except ApiException as e:
print("Exception when calling AgentAssistantsApi->delete_assistant_queue: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/assistants/{assistantId}/queues/{queueId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get queue Information for an assistant. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentAssistantsApi();
assistant_id = 'assistant_id_example' # str | Assistant ID
queue_id = 'queue_id_example' # str | Queue ID
expand = 'expand_example' # str | Which fields, if any, to expand. (optional)
try:
# Get queue Information for an assistant.
api_response = api_instance.get_assistant_queue(assistant_id, queue_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentAssistantsApi->get_assistant_queue: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/assistants/{assistantId}/queues/{queueId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create a queue assistant association. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentAssistantsApi();
assistant_id = 'assistant_id_example' # str | Assistant ID
queue_id = 'queue_id_example' # str | Queue ID
body = PureCloudPlatformClientV2.AssistantQueue() # AssistantQueue |
try:
# Create a queue assistant association.
api_response = api_instance.put_assistant_queue(assistant_id, queue_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentAssistantsApi->put_assistant_queue: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/assistants/{assistantId}/copilot Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get copilot configuration of an assistant. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentCopilotApi();
assistant_id = 'assistant_id_example' # str | Assistant ID
try:
# Get copilot configuration of an assistant.
api_response = api_instance.get_assistant_copilot(assistant_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentCopilotApi->get_assistant_copilot: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/assistants/{assistantId}/copilot Genesys Cloud Python SDK. | Genesys describes this as an API used to: Update agent copilot configuration | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AgentCopilotApi();
assistant_id = 'assistant_id_example' # str | Assistant ID
body = PureCloudPlatformClientV2.Copilot() # Copilot |
try:
# Update agent copilot configuration
api_response = api_instance.put_assistant_copilot(assistant_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AgentCopilotApi->put_assistant_copilot: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete agent auto answer settings | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to
try:
# Delete agent auto answer settings
api_instance.delete_users_agentui_agents_autoanswer_agent_id_settings(agent_id)
except ApiException as e:
print("Exception when calling SettingsApi->delete_users_agentui_agents_autoanswer_agent_id_settings: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get agent auto answer settings | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to
try:
# Get agent auto answer settings
api_response = api_instance.get_users_agentui_agents_autoanswer_agent_id_settings(agent_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SettingsApi->get_users_agentui_agents_autoanswer_agent_id_settings: %s\n" % e)``` |
Provide a Python example that uses the PATCH /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK. | Genesys describes this as an API used to: Update agent auto answer settings | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to
body = PureCloudPlatformClientV2.AutoAnswerSettings() # AutoAnswerSettings | AutoAnswerSettings
try:
# Update agent auto answer settings
api_response = api_instance.patch_users_agentui_agents_autoanswer_agent_id_settings(agent_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SettingsApi->patch_users_agentui_agents_autoanswer_agent_id_settings: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK. | Genesys describes this as an API used to: Set agent auto answer settings | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to
body = PureCloudPlatformClientV2.AutoAnswerSettings() # AutoAnswerSettings | AutoAnswerSettings
try:
# Set agent auto answer settings
api_response = api_instance.put_users_agentui_agents_autoanswer_agent_id_settings(agent_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SettingsApi->put_users_agentui_agents_autoanswer_agent_id_settings: %s\n" % e)``` |
Provide a Python example that uses the PATCH /api/v2/alerting/alerts/bulk Genesys Cloud Python SDK. | Genesys describes this as an API used to: Bulk alert updates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
body = PureCloudPlatformClientV2.CommonAlertBulkUpdateRequest() # CommonAlertBulkUpdateRequest |
try:
# Bulk alert updates
api_response = api_instance.patch_alerting_alerts_bulk(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertingApi->patch_alerting_alerts_bulk: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/alerting/alerts/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Gets a paged list of alerts. The max page size is 50 | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
body = PureCloudPlatformClientV2.GetAlertQuery() # GetAlertQuery | (optional)
try:
# Gets a paged list of alerts. The max page size is 50
api_response = api_instance.post_alerting_alerts_query(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertingApi->post_alerting_alerts_query: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/alerting/alerts/{alertId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete an alert | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
alert_id = 'alert_id_example' # str | Alert ID
try:
# Delete an alert
api_instance.delete_alerting_alert(alert_id)
except ApiException as e:
print("Exception when calling AlertingApi->delete_alerting_alert: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/alerting/alerts/{alertId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get an alert | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
alert_id = 'alert_id_example' # str | Alert ID
try:
# Get an alert
api_response = api_instance.get_alerting_alert(alert_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertingApi->get_alerting_alert: %s\n" % e)``` |
Provide a Python example that uses the PATCH /api/v2/alerting/alerts/{alertId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Allows an entity to mute/snooze an alert or update the unread status of the alert. Snoozing an alert temporarily stop it from resending notifications to individualsas well as other services within Genesys Cloud for a given period. Muting an alert will only block the notifications to individuals. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
alert_id = 'alert_id_example' # str | Alert ID
body = PureCloudPlatformClientV2.AlertRequest() # AlertRequest | (optional)
try:
# Allows an entity to mute/snooze an alert or update the unread status of the alert.
api_response = api_instance.patch_alerting_alert(alert_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertingApi->patch_alerting_alert: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/alerting/alerts/{alertId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Update an alert read status | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
alert_id = 'alert_id_example' # str | Alert ID
body = PureCloudPlatformClientV2.AlertingUnreadStatus() # AlertingUnreadStatus | (optional)
try:
# Update an alert read status
api_response = api_instance.put_alerting_alert(alert_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertingApi->put_alerting_alert: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/alerting/rules Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create a Rule. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
body = PureCloudPlatformClientV2.CommonRule() # CommonRule | rule to be created
try:
# Create a Rule.
api_response = api_instance.post_alerting_rules(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertingApi->post_alerting_rules: %s\n" % e)``` |
Provide a Python example that uses the PATCH /api/v2/alerting/rules/bulk Genesys Cloud Python SDK. | Genesys describes this as an API used to: Bulk update of notification lists | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
body = PureCloudPlatformClientV2.CommonRuleBulkUpdateNotificationsRequest() # CommonRuleBulkUpdateNotificationsRequest |
try:
# Bulk update of notification lists
api_response = api_instance.patch_alerting_rules_bulk(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertingApi->patch_alerting_rules_bulk: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/alerting/rules/bulk/remove Genesys Cloud Python SDK. | Genesys describes this as an API used to: Bulk remove rules | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
body = PureCloudPlatformClientV2.CommonRuleBulkDeleteRequest() # CommonRuleBulkDeleteRequest |
try:
# Bulk remove rules
api_response = api_instance.post_alerting_rules_bulk_remove(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertingApi->post_alerting_rules_bulk_remove: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/alerting/rules/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a paged list of rules. The max size of the page is 50 items. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
body = PureCloudPlatformClientV2.GetRulesQuery() # GetRulesQuery | (optional)
try:
# Get a paged list of rules. The max size of the page is 50 items.
api_response = api_instance.post_alerting_rules_query(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertingApi->post_alerting_rules_query: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/alerting/rules/{ruleId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete a rule. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
rule_id = 'rule_id_example' # str | Rule Id
try:
# Delete a rule.
api_instance.delete_alerting_rule(rule_id)
except ApiException as e:
print("Exception when calling AlertingApi->delete_alerting_rule: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/alerting/rules/{ruleId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a rule. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
rule_id = 'rule_id_example' # str | Rule Id
try:
# Get a rule.
api_response = api_instance.get_alerting_rule(rule_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertingApi->get_alerting_rule: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/alerting/rules/{ruleId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Update a rule | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AlertingApi();
rule_id = 'rule_id_example' # str | Rule Id
body = PureCloudPlatformClientV2.ModifiableRuleProperties() # ModifiableRuleProperties | rule to be updated
try:
# Update a rule
api_response = api_instance.put_alerting_rule(rule_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertingApi->put_alerting_rule: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/actions/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for action aggregates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = PureCloudPlatformClientV2.ActionAggregationQuery() # ActionAggregationQuery | query
try:
# Query for action aggregates
api_response = api_instance.post_analytics_actions_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->post_analytics_actions_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/agentcopilots/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for agent copilot aggregates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = PureCloudPlatformClientV2.AgentCopilotAggregationQuery() # AgentCopilotAggregationQuery | query
try:
# Query for agent copilot aggregates
api_response = api_instance.post_analytics_agentcopilots_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->post_analytics_agentcopilots_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get Reporting Turns (division aware). Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
bot_flow_id = 'bot_flow_id_example' # str | ID of the bot flow.
after = 'after_example' # str | The cursor that points to the ID of the last item in the list of entities that has been returned. (optional)
page_size = ''50'' # str | Max number of entities to return. Maximum of 250 (optional) (default to '50')
interval = '2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z' # str | 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 (optional)
action_id = 'action_id_example' # str | Optional action ID to get the reporting turns associated to a particular flow action (optional)
session_id = 'session_id_example' # str | 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. (optional)
language = 'en-us' # str | Optional language code to get the reporting turns for a particular language (optional)
ask_action_results = 'ask_action_results_example' # str | Optional case-insensitive comma separated list of ask action results to filter the reporting turns. (optional)
try:
# Get Reporting Turns (division aware).
api_response = api_instance.get_analytics_botflow_divisions_reportingturns(bot_flow_id, after=after, page_size=page_size, interval=interval, action_id=action_id, session_id=session_id, language=language, ask_action_results=ask_action_results)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->get_analytics_botflow_divisions_reportingturns: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/botflows/{botFlowId}/sessions Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get Bot Flow Sessions. Returns the bot flow sessions in reverse chronological order from the date they were created. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
bot_flow_id = 'bot_flow_id_example' # str | ID of the bot flow.
after = 'after_example' # str | The cursor that points to the ID of the last item in the list of entities that has been returned. (optional)
page_size = ''50'' # str | Max number of entities to return. Maximum of 250 (optional) (default to '50')
interval = '2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z' # str | 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 (optional)
bot_result_categories = 'bot_result_categories_example' # str | Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by. (optional)
end_language = 'end_language_example' # str | Optional case-insensitive language code to filter sessions by the language the sessions ended in. (optional)
try:
# Get Bot Flow Sessions.
api_response = api_instance.get_analytics_botflow_sessions(bot_flow_id, after=after, page_size=page_size, interval=interval, bot_result_categories=bot_result_categories, end_language=end_language)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->get_analytics_botflow_sessions: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/bots/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for bot aggregates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = PureCloudPlatformClientV2.BotAggregationQuery() # BotAggregationQuery | query
try:
# Query for bot aggregates
api_response = api_instance.post_analytics_bots_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->post_analytics_bots_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/conversations/activity/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for conversation activity observations | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.ConversationActivityQuery() # ConversationActivityQuery | query
page_size = 56 # int | The desired page size (optional)
page_number = 56 # int | The desired page number (optional)
try:
# Query for conversation activity observations
api_response = api_instance.post_analytics_conversations_activity_query(body, page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_analytics_conversations_activity_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/conversations/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for conversation aggregates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.ConversationAggregationQuery() # ConversationAggregationQuery | query
try:
# Query for conversation aggregates
api_response = api_instance.post_analytics_conversations_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_analytics_conversations_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/conversations/details Genesys Cloud Python SDK. | Genesys describes this as an API used to: Gets multiple conversations by id | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
id = ['id_example'] # list[str] | Comma-separated conversation ids (optional)
try:
# Gets multiple conversations by id
api_response = api_instance.get_analytics_conversations_details(id=id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_analytics_conversations_details: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/conversations/details/jobs Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for conversation details asynchronously | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.AsyncConversationQuery() # AsyncConversationQuery | query
try:
# Query for conversation details asynchronously
api_response = api_instance.post_analytics_conversations_details_jobs(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_analytics_conversations_details_jobs: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/conversations/details/jobs/availability Genesys Cloud Python SDK. | Genesys describes this as an API used to: Lookup the datalake availability date and time | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
try:
# Lookup the datalake availability date and time
api_response = api_instance.get_analytics_conversations_details_jobs_availability()
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_analytics_conversations_details_jobs_availability: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/analytics/conversations/details/jobs/{jobId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete/cancel an async details job | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
job_id = 'job_id_example' # str | jobId
try:
# Delete/cancel an async details job
api_instance.delete_analytics_conversations_details_job(job_id)
except ApiException as e:
print("Exception when calling ConversationsApi->delete_analytics_conversations_details_job: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/conversations/details/jobs/{jobId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get status for async query for conversation details | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
job_id = 'job_id_example' # str | jobId
try:
# Get status for async query for conversation details
api_response = api_instance.get_analytics_conversations_details_job(job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_analytics_conversations_details_job: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/conversations/details/jobs/{jobId}/results Genesys Cloud Python SDK. | Genesys describes this as an API used to: Fetch a page of results for an async details job | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
job_id = 'job_id_example' # str | jobId
cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page) (optional)
page_size = 56 # int | The desired maximum number of results (optional)
try:
# Fetch a page of results for an async details job
api_response = api_instance.get_analytics_conversations_details_job_results(job_id, cursor=cursor, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_analytics_conversations_details_job_results: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/conversations/details/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for conversation details | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.ConversationQuery() # ConversationQuery | query
try:
# Query for conversation details
api_response = api_instance.post_analytics_conversations_details_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_analytics_conversations_details_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/conversations/transcripts/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Search resources. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SearchApi();
body = PureCloudPlatformClientV2.TranscriptConversationDetailSearchRequest() # TranscriptConversationDetailSearchRequest | Search request options
try:
# Search resources.
api_response = api_instance.post_analytics_conversations_transcripts_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->post_analytics_conversations_transcripts_query: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/conversations/{conversationId}/details Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a conversation by id | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
try:
# Get a conversation by id
api_response = api_instance.get_analytics_conversation_details(conversation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_analytics_conversation_details: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/conversations/{conversationId}/details/properties Genesys Cloud Python SDK. | Genesys describes this as an API used to: Index conversation properties | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
body = PureCloudPlatformClientV2.PropertyIndexRequest() # PropertyIndexRequest | request
try:
# Index conversation properties
api_response = api_instance.post_analytics_conversation_details_properties(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_analytics_conversation_details_properties: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/dataretention/settings Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get analytics data retention setting | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
try:
# Get analytics data retention setting
api_response = api_instance.get_analytics_dataretention_settings()
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->get_analytics_dataretention_settings: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/analytics/dataretention/settings Genesys Cloud Python SDK. | Genesys describes this as an API used to: Update analytics data retention setting | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = PureCloudPlatformClientV2.UpdateAnalyticsDataRetentionRequest() # UpdateAnalyticsDataRetentionRequest | retentionDays
try:
# Update analytics data retention setting
api_response = api_instance.put_analytics_dataretention_settings(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->put_analytics_dataretention_settings: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/evaluations/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for evaluation aggregates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.QualityApi();
body = PureCloudPlatformClientV2.EvaluationAggregationQuery() # EvaluationAggregationQuery | query
try:
# Query for evaluation aggregates
api_response = api_instance.post_analytics_evaluations_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling QualityApi->post_analytics_evaluations_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/flowexecutions/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for flow execution aggregates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = PureCloudPlatformClientV2.FlowExecutionAggregationQuery() # FlowExecutionAggregationQuery | query
try:
# Query for flow execution aggregates
api_response = api_instance.post_analytics_flowexecutions_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->post_analytics_flowexecutions_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/flows/activity/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for flow activity observations | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.FlowsApi();
body = PureCloudPlatformClientV2.FlowActivityQuery() # FlowActivityQuery | query
page_size = 56 # int | The desired page size (optional)
page_number = 56 # int | The desired page number (optional)
try:
# Query for flow activity observations
api_response = api_instance.post_analytics_flows_activity_query(body, page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling FlowsApi->post_analytics_flows_activity_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/flows/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for flow aggregates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.FlowsApi();
body = PureCloudPlatformClientV2.FlowAggregationQuery() # FlowAggregationQuery | query
try:
# Query for flow aggregates
api_response = api_instance.post_analytics_flows_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling FlowsApi->post_analytics_flows_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/flows/observations/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for flow observations | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.FlowsApi();
body = PureCloudPlatformClientV2.FlowObservationQuery() # FlowObservationQuery | query
try:
# Query for flow observations
api_response = api_instance.post_analytics_flows_observations_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling FlowsApi->post_analytics_flows_observations_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/journeys/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for journey aggregates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.JourneyApi();
body = PureCloudPlatformClientV2.JourneyAggregationQuery() # JourneyAggregationQuery | query
try:
# Query for journey aggregates
api_response = api_instance.post_analytics_journeys_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling JourneyApi->post_analytics_journeys_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/knowledge/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for knowledge aggregates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = PureCloudPlatformClientV2.KnowledgeAggregationQuery() # KnowledgeAggregationQuery | query
try:
# Query for knowledge aggregates
api_response = api_instance.post_analytics_knowledge_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->post_analytics_knowledge_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/queues/observations/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for queue observations | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.RoutingApi();
body = PureCloudPlatformClientV2.QueueObservationQuery() # QueueObservationQuery | query
try:
# Query for queue observations
api_response = api_instance.post_analytics_queues_observations_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling RoutingApi->post_analytics_queues_observations_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/ratelimits/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: 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. The 'max' property can be used to determine estimated rate limit value hit. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled). | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = PureCloudPlatformClientV2.RateLimitAggregationQuery() # RateLimitAggregationQuery | query
try:
# 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.
api_response = api_instance.post_analytics_ratelimits_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->post_analytics_ratelimits_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/reporting/dashboards/users Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get dashboards summary for users in a org | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
sort_by = ''asc'' # str | (optional) (default to 'asc')
page_number = 1 # int | (optional) (default to 1)
page_size = 25 # int | (optional) (default to 25)
id = ['id_example'] # list[str] | A list of user IDs to fetch by bulk (optional)
state = 'state_example' # str | Only list users of this state (optional)
try:
# Get dashboards summary for users in a org
api_response = api_instance.get_analytics_reporting_dashboards_users(sort_by=sort_by, page_number=page_number, page_size=page_size, id=id, state=state)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->get_analytics_reporting_dashboards_users: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/reporting/dashboards/users/bulk/remove Genesys Cloud Python SDK. | Genesys describes this as an API used to: Bulk delete dashboards owned by other user(s) | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = ['body_example'] # list[str] | List of userIds
try:
# Bulk delete dashboards owned by other user(s)
api_instance.post_analytics_reporting_dashboards_users_bulk_remove(body)
except ApiException as e:
print("Exception when calling AnalyticsApi->post_analytics_reporting_dashboards_users_bulk_remove: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/reporting/dashboards/users/{userId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get dashboards summary for a user | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
user_id = 'user_id_example' # str | User ID
try:
# Get dashboards summary for a user
api_response = api_instance.get_analytics_reporting_dashboards_user(user_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->get_analytics_reporting_dashboards_user: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/reporting/exports Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get all view export requests for a user | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get all view export requests for a user
api_response = api_instance.get_analytics_reporting_exports(page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->get_analytics_reporting_exports: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/reporting/exports Genesys Cloud Python SDK. | Genesys describes this as an API used to: Generate a view export request. This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = PureCloudPlatformClientV2.ReportingExportJobRequest() # ReportingExportJobRequest | ReportingExportJobRequest
try:
# Generate a view export request
api_response = api_instance.post_analytics_reporting_exports(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->post_analytics_reporting_exports: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/reporting/exports/metadata Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get all export metadata | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
try:
# Get all export metadata
api_response = api_instance.get_analytics_reporting_exports_metadata()
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->get_analytics_reporting_exports_metadata: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/reporting/settings Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get AnalyticsReportingSettings for an organization | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
try:
# Get AnalyticsReportingSettings for an organization
api_response = api_instance.get_analytics_reporting_settings()
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->get_analytics_reporting_settings: %s\n" % e)``` |
Provide a Python example that uses the PATCH /api/v2/analytics/reporting/settings Genesys Cloud Python SDK. | Genesys describes this as an API used to: Patch AnalyticsReportingSettings values for an organization | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = PureCloudPlatformClientV2.AnalyticsReportingSettings() # AnalyticsReportingSettings | AnalyticsReportingSettingsRequest
try:
# Patch AnalyticsReportingSettings values for an organization
api_response = api_instance.patch_analytics_reporting_settings(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->patch_analytics_reporting_settings: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/reporting/settings/dashboards/bulk/remove Genesys Cloud Python SDK. | Genesys describes this as an API used to: Bulk remove dashboard configurations | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = PureCloudPlatformClientV2.DashboardConfigurationBulkRequest() # DashboardConfigurationBulkRequest |
try:
# Bulk remove dashboard configurations
api_instance.post_analytics_reporting_settings_dashboards_bulk_remove(body)
except ApiException as e:
print("Exception when calling AnalyticsApi->post_analytics_reporting_settings_dashboards_bulk_remove: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/reporting/settings/dashboards/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get list of dashboard configurations | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
dashboard_type = 'dashboard_type_example' # str | List dashboard of given type
dashboard_access_filter = 'dashboard_access_filter_example' # str | Filter dashboard based on the owner of dashboard
name = 'name_example' # str | name of the dashboard (optional)
sort_by = ''desc'' # str | (optional) (default to 'desc')
page_number = 1 # int | (optional) (default to 1)
page_size = 9 # int | (optional) (default to 9)
try:
# Get list of dashboard configurations
api_response = api_instance.get_analytics_reporting_settings_dashboards_query(dashboard_type, dashboard_access_filter, name=name, sort_by=sort_by, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->get_analytics_reporting_settings_dashboards_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/reporting/settings/dashboards/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query dashboard configurations | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = PureCloudPlatformClientV2.DashboardConfigurationQueryRequest() # DashboardConfigurationQueryRequest |
try:
# Query dashboard configurations
api_response = api_instance.post_analytics_reporting_settings_dashboards_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->post_analytics_reporting_settings_dashboards_query: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/reporting/settings/users/{userId}/dashboards Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get list of dashboards for an user | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
user_id = 'user_id_example' # str | User ID
sort_by = ''asc'' # str | (optional) (default to 'asc')
page_number = 1 # int | (optional) (default to 1)
page_size = 50 # int | (optional) (default to 50)
public_only = True # bool | If true, retrieve only public dashboards (optional)
favorite_only = True # bool | If true, retrieve only favorite dashboards (optional)
name = 'name_example' # str | retrieve dashboards that match with given name (optional)
try:
# Get list of dashboards for an user
api_response = api_instance.get_analytics_reporting_settings_user_dashboards(user_id, sort_by=sort_by, page_number=page_number, page_size=page_size, public_only=public_only, favorite_only=favorite_only, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->get_analytics_reporting_settings_user_dashboards: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/routing/activity/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for user activity observations | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.RoutingApi();
body = PureCloudPlatformClientV2.RoutingActivityQuery() # RoutingActivityQuery | query
page_size = 56 # int | The desired page size (optional)
page_number = 56 # int | The desired page number (optional)
try:
# Query for user activity observations
api_response = api_instance.post_analytics_routing_activity_query(body, page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling RoutingApi->post_analytics_routing_activity_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/surveys/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for survey aggregates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.QualityApi();
body = PureCloudPlatformClientV2.SurveyAggregationQuery() # SurveyAggregationQuery | query
try:
# Query for survey aggregates
api_response = api_instance.post_analytics_surveys_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling QualityApi->post_analytics_surveys_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/teams/activity/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for team activity observations | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TeamsApi();
body = PureCloudPlatformClientV2.TeamActivityQuery() # TeamActivityQuery | query
page_size = 56 # int | The desired page size (optional)
page_number = 56 # int | The desired page number (optional)
try:
# Query for team activity observations
api_response = api_instance.post_analytics_teams_activity_query(body, page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling TeamsApi->post_analytics_teams_activity_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/transcripts/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for transcript aggregates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.AnalyticsApi();
body = PureCloudPlatformClientV2.TranscriptAggregationQuery() # TranscriptAggregationQuery | query
try:
# Query for transcript aggregates
api_response = api_instance.post_analytics_transcripts_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AnalyticsApi->post_analytics_transcripts_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/users/activity/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for user activity observations | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
body = PureCloudPlatformClientV2.UserActivityQuery() # UserActivityQuery | query
page_size = 56 # int | The desired page size (optional)
page_number = 56 # int | The desired page number (optional)
try:
# Query for user activity observations
api_response = api_instance.post_analytics_users_activity_query(body, page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->post_analytics_users_activity_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/users/aggregates/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for user aggregates | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
body = PureCloudPlatformClientV2.UserAggregationQuery() # UserAggregationQuery | query
try:
# Query for user aggregates
api_response = api_instance.post_analytics_users_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->post_analytics_users_aggregates_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/users/details/jobs Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for user details asynchronously | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
body = PureCloudPlatformClientV2.AsyncUserDetailsQuery() # AsyncUserDetailsQuery | query
try:
# Query for user details asynchronously
api_response = api_instance.post_analytics_users_details_jobs(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->post_analytics_users_details_jobs: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/users/details/jobs/availability Genesys Cloud Python SDK. | Genesys describes this as an API used to: Lookup the datalake availability date and time | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
try:
# Lookup the datalake availability date and time
api_response = api_instance.get_analytics_users_details_jobs_availability()
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->get_analytics_users_details_jobs_availability: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/analytics/users/details/jobs/{jobId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete/cancel an async request | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
job_id = 'job_id_example' # str | jobId
try:
# Delete/cancel an async request
api_instance.delete_analytics_users_details_job(job_id)
except ApiException as e:
print("Exception when calling UsersApi->delete_analytics_users_details_job: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/users/details/jobs/{jobId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get status for async query for user details | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
job_id = 'job_id_example' # str | jobId
try:
# Get status for async query for user details
api_response = api_instance.get_analytics_users_details_job(job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->get_analytics_users_details_job: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/analytics/users/details/jobs/{jobId}/results Genesys Cloud Python SDK. | Genesys describes this as an API used to: Fetch a page of results for an async query | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
job_id = 'job_id_example' # str | jobId
cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page) (optional)
page_size = 56 # int | The desired maximum number of results (optional)
try:
# Fetch a page of results for an async query
api_response = api_instance.get_analytics_users_details_job_results(job_id, cursor=cursor, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->get_analytics_users_details_job_results: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/users/details/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for user details | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
body = PureCloudPlatformClientV2.UserDetailsQuery() # UserDetailsQuery | query
try:
# Query for user details
api_response = api_instance.post_analytics_users_details_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->post_analytics_users_details_query: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/analytics/users/observations/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query for user observations | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
body = PureCloudPlatformClientV2.UserObservationQuery() # UserObservationQuery | query
try:
# Query for user observations
api_response = api_instance.post_analytics_users_observations_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->post_analytics_users_observations_query: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/dependencytracking Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get Dependency Tracking objects that have a given display name | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
name = 'name_example' # str | Object name to search for
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
object_type = ['object_type_example'] # list[str] | Object type(s) to search for (optional)
consumed_resources = True # bool | Include resources each result item consumes (optional)
consuming_resources = True # bool | Include resources that consume each result item (optional)
consumed_resource_type = ['consumed_resource_type_example'] # list[str] | Types of consumed resources to return, if consumed resources are requested (optional)
consuming_resource_type = ['consuming_resource_type_example'] # list[str] | Types of consuming resources to return, if consuming resources are requested (optional)
try:
# Get Dependency Tracking objects that have a given display name
api_response = api_instance.get_architect_dependencytracking(name, page_number=page_number, page_size=page_size, object_type=object_type, consumed_resources=consumed_resources, consuming_resources=consuming_resources, consumed_resource_type=consumed_resource_type, consuming_resource_type=consuming_resource_type)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_dependencytracking: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/dependencytracking/build Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get Dependency Tracking build status for an organization | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
try:
# Get Dependency Tracking build status for an organization
api_response = api_instance.get_architect_dependencytracking_build()
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_dependencytracking_build: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/dependencytracking/build Genesys Cloud Python SDK. | Genesys describes this as an API used to: Rebuild Dependency Tracking data for an organization. Asynchronous. Notification topic: v2.architect.dependencytracking.build | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
try:
# Rebuild Dependency Tracking data for an organization
api_instance.post_architect_dependencytracking_build()
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_dependencytracking_build: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/dependencytracking/consumedresources Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get resources that are consumed by a given Dependency Tracking object | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
id = 'id_example' # str | Consuming object ID
version = 'version_example' # str | Consuming object version
object_type = 'object_type_example' # str | Consuming object type. Only versioned types are allowed here.
resource_type = ['resource_type_example'] # list[str] | Types of consumed resources to show (optional)
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get resources that are consumed by a given Dependency Tracking object
api_response = api_instance.get_architect_dependencytracking_consumedresources(id, version, object_type, resource_type=resource_type, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_dependencytracking_consumedresources: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/dependencytracking/consumingresources Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get resources that consume a given Dependency Tracking object | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
id = 'id_example' # str | Consumed object ID
object_type = 'object_type_example' # str | Consumed object type
resource_type = ['resource_type_example'] # list[str] | Types of consuming resources to show. Only versioned types are allowed here. (optional)
version = 'version_example' # str | Object version (optional)
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
flow_filter = 'flow_filter_example' # str | Show only checkedIn or published flows (optional)
try:
# Get resources that consume a given Dependency Tracking object
api_response = api_instance.get_architect_dependencytracking_consumingresources(id, object_type, resource_type=resource_type, version=version, page_number=page_number, page_size=page_size, flow_filter=flow_filter)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_dependencytracking_consumingresources: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/dependencytracking/deletedresourceconsumers Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get Dependency Tracking objects that consume deleted resources | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
name = 'name_example' # str | Name to search for (optional)
object_type = ['object_type_example'] # list[str] | Object type(s) to search for (optional)
flow_filter = 'flow_filter_example' # str | Show only checkedIn or published flows (optional)
consumed_resources = False # bool | Return consumed resources? (optional) (default to False)
consumed_resource_type = ['consumed_resource_type_example'] # list[str] | Resource type(s) to return (optional)
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get Dependency Tracking objects that consume deleted resources
api_response = api_instance.get_architect_dependencytracking_deletedresourceconsumers(name=name, object_type=object_type, flow_filter=flow_filter, consumed_resources=consumed_resources, consumed_resource_type=consumed_resource_type, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_dependencytracking_deletedresourceconsumers: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/dependencytracking/object Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a Dependency Tracking object | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
id = 'id_example' # str | Object ID
version = 'version_example' # str | Object version (optional)
object_type = 'object_type_example' # str | Object type (optional)
consumed_resources = True # bool | Include resources this item consumes (optional)
consuming_resources = True # bool | Include resources that consume this item (optional)
consumed_resource_type = ['consumed_resource_type_example'] # list[str] | Types of consumed resources to return, if consumed resources are requested (optional)
consuming_resource_type = ['consuming_resource_type_example'] # list[str] | Types of consuming resources to return, if consuming resources are requested (optional)
consumed_resource_request = True # bool | Indicate that this is going to look up a consumed resource object (optional)
try:
# Get a Dependency Tracking object
api_response = api_instance.get_architect_dependencytracking_object(id, version=version, object_type=object_type, consumed_resources=consumed_resources, consuming_resources=consuming_resources, consumed_resource_type=consumed_resource_type, consuming_resource_type=consuming_resource_type, consumed_resource_request=consumed_resource_request)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_dependencytracking_object: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/dependencytracking/types Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get Dependency Tracking types. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get Dependency Tracking types.
api_response = api_instance.get_architect_dependencytracking_types(page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_dependencytracking_types: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/dependencytracking/types/{typeId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a Dependency Tracking type. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
type_id = 'type_id_example' # str | Type ID
try:
# Get a Dependency Tracking type.
api_response = api_instance.get_architect_dependencytracking_type(type_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_dependencytracking_type: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/dependencytracking/updatedresourceconsumers Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get Dependency Tracking objects that depend on updated resources | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
name = 'name_example' # str | Name to search for (optional)
object_type = ['object_type_example'] # list[str] | Object type(s) to search for (optional)
consumed_resources = False # bool | Return consumed resources? (optional) (default to False)
consumed_resource_type = ['consumed_resource_type_example'] # list[str] | Resource type(s) to return (optional)
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get Dependency Tracking objects that depend on updated resources
api_response = api_instance.get_architect_dependencytracking_updatedresourceconsumers(name=name, object_type=object_type, consumed_resources=consumed_resources, consumed_resource_type=consumed_resource_type, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_dependencytracking_updatedresourceconsumers: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/emergencygroups Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a list of emergency groups. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''name'' # str | Sort by (optional) (default to 'name')
sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC')
name = 'name_example' # str | Name of the Emergency Group to filter by. (optional)
try:
# Get a list of emergency groups.
api_response = api_instance.get_architect_emergencygroups(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_emergencygroups: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/emergencygroups Genesys Cloud Python SDK. | Genesys describes this as an API used to: Creates a new emergency group | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.EmergencyGroup() # EmergencyGroup |
try:
# Creates a new emergency group
api_response = api_instance.post_architect_emergencygroups(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_emergencygroups: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/emergencygroups/divisionviews Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a pageable list of basic emergency group objects filterable by query parameters. This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''name'' # str | Sort by (optional) (default to 'name')
sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC')
id = ['id_example'] # list[str] | ID of the Emergency Groups to filter by. (optional)
name = 'name_example' # str | Name of the Emergency Group to filter by. (optional)
division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional)
try:
# Get a pageable list of basic emergency group objects filterable by query parameters.
api_response = api_instance.get_architect_emergencygroups_divisionviews(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, division_id=division_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_emergencygroups_divisionviews: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/emergencygroups/{emergencyGroupId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Deletes a emergency group by ID | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
emergency_group_id = 'emergency_group_id_example' # str | Emergency group ID
try:
# Deletes a emergency group by ID
api_instance.delete_architect_emergencygroup(emergency_group_id)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_emergencygroup: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/emergencygroups/{emergencyGroupId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Gets a emergency group by ID | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
emergency_group_id = 'emergency_group_id_example' # str | Emergency group ID
try:
# Gets a emergency group by ID
api_response = api_instance.get_architect_emergencygroup(emergency_group_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_emergencygroup: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/architect/emergencygroups/{emergencyGroupId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Updates a emergency group by ID | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
emergency_group_id = 'emergency_group_id_example' # str | Emergency group ID
body = PureCloudPlatformClientV2.EmergencyGroup() # EmergencyGroup |
try:
# Updates a emergency group by ID
api_response = api_instance.put_architect_emergencygroup(emergency_group_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->put_architect_emergencygroup: %s\n" % e)``` |
End of preview. Expand
in Data Studio
README.md exists but content is empty.
- Downloads last month
- 56