This method authenticates a user on a server. In the case of successful authentication, the server sets session cookies.
\n"],"query":[],"variable":[]}},"response":[{"id":"53a7198d-0378-4e39-9079-f524aa66d380","name":"Authenticate","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tenant_url\" : \"yourcompany.brightpattern.com\",\r\n \"username\" : \"stats.user\",\r\n \"password\" : \"SecurePassword!\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.brightpattern.com/statsapi/auth"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"token\": \"61XXXXX2-XEX5-4XBX-81C3-14CXXXXXX721\",\r\n \"privileges\": [\r\n \"PUSH_PULL_GLOBAL_WALLBOARDS\",\r\n \"CUSTOMIZE_WALLBOARDS\",\r\n \"SYS_USE_AGENT_SEAT_MAPS\"\r\n ],\r\n \"user_id\": \"XXXC49E4-E9XX-4XFX-X4X4-62XXXXXXXX8E\"\r\n}"}],"_postman_id":"2e6eeb2e-4f9d-4412-8e40-f708d9d22c46"}],"id":"c6220bcc-7bf9-4b21-9357-e1c146b53578","description":"This API supports two forms of authentication: OAuth 2.0 and Basic
\nOAuth 2.0 Authentication
\nThe OAuth 2.0 Client Credentials Grant is used to authenticate clients of this API, using the Get Access Token method. The authenticated user is checked for having appropriate privileges to perform the requested operation. The complete list of privileges can be found here. Privileges are assigned to users via one or more Roles.
\nTo obtain an access token:
\n\n- Login to your BPCC configuration portal.
\n- Navigate to the Users page.
\n- Select or create a user; the user must:
\n- Have the following privileges:
\n- Access Realtime Stats API
\n- View real-time agent metrics
\n- View real-time service metrics
\n- Be assigned as a team supervisor (i.e., they will get metrics for agents of this team and services handled by this team)
\n
\n \n- Click the Generate button to generate an API secret key. Copy the generated key and note the username for the next steps.
Use the Get Access Token method to obtain an access token. Set the client_id to the above username and the client_secret to the generated API secret key.
Use the value of access_token returned in the response to set the Authorization: Bearer [access token] header of each subsequent request made via the BPCC Real-Time Stats API. \n
\nNotes:
This method of authentication may be used starting from Bright Pattern Contact Center version 5.5.5.
\nBasic Authentication
\nBasic authentication authenticates a user on a server using the Authenticate method. In the case of successful authentication, the server sets session cookies.
\nHow to Use
\nFor both authentication methods, a successful response contains a token. When making any other requests with methods from this API, you will include the token in the corresponding header type.
\nWhen using the Authenticate method, the token will be included in a Cookie header; structure is as follows:
\nCookie:X-STATSAPI-TOKEN=61XXXXX2-XEX5-4XBX-81C3-14CXXXXXX721; X-STATSAPI-TENANT=tenant_URL; X-STATSAPI-LOGIN=user.name\n\n
Note that the cookie is valid until the next user logs into any wallboard (i.e., one cookie per user).
\nWhen using the Get Access Token method, the token will be included in a Authorization header; the structure is as follows:
\nAuthorization: Bearer <access_token>\n
","event":[{"listen":"prerequest","script":{"id":"834d2616-f89a-4290-8e0a-11f6e1962b95","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c6dcf48a-6977-49df-9b98-1e4d0b4dbd49","type":"text/javascript","exec":[""]}}],"_postman_id":"c6220bcc-7bf9-4b21-9357-e1c146b53578"},{"name":"Methods","item":[{"name":"Create Subscription","id":"9deb0657-9bc5-400c-8873-ca7ee5689a96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"\": {\r\n \"stats_totals\": [\"statistic name\" ], //array of statistics\r\n \"service_grids\": [//array of service grid definitions \r\n {\r\n \"id\": \"\",\r\n \"columns\": [//array of stats for columns\r\n {\r\n \"id\": \"\",\r\n \"stat_name\": \"\"\r\n }\r\n ], \r\n \"order_by\": \"\",\r\n \"order_dir\": \"ASC|DESC\",\r\n \"limit\": \"\",\r\n \"filter_by\": \"\",\r\n \"filter_value\": \"\",\r\n \"filter_operation\": \"EQ|NE|LT|GT|LE|GE\"\r\n }\r\n ],\r\n \"agent_grids\": [ //array of agent grid definitions \r\n {\r\n \"id\": \"\",\r\n \"columns\": [//array of stats for columns\r\n {\r\n \"id\": \"\",\r\n \"stat_name\": \"\", \r\n \"dispositions\": [\"<(optional)list of dispositions>\"]\r\n }\r\n ], \r\n \"order_by\": \"\",\r\n \"order_dir\": \"ASC|DESC\",\r\n \"limit\": \"\",\r\n \"filter_by\": \"\",\r\n \"filter_value\": \"\",\r\n \"filter_operation\": \"EQ|NE|LT|GT|LE|GE\"\r\n }\r\n ],\r\n \"chat_messages\": {//top of internal chat messages \r\n \"filter\": \"\",\r\n \"limit\": \"\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https:///statsapi/subscription","description":"This method creates a subscription for a specific set of metrics. Each client can have only one active subscription.
\nResponse Codes
\n\n\n\n| Code | \nDescription | \n
\n\n\n\n| 200 | \nOK subscription was created | \n
\n\n| 400 | \nBad request | \n
\n\n| 401 | \nUnauthorized | \n
\n\n| 409 | \nLimit of active subscriptions exceeded for tenant | \n
\n\n
\n
This method gets the statistics data of an active subscription.
\nNote:
\n\n- Your user must be the supervisor of a team in order to retrieve agent_grid information.
\n
\nResponse Codes
\n\n\n\n| Code | \nDescription | \n
\n\n\n\n| 200 | \nOK | \n
\n\n| 204 | \nNo content (data is not ready yet) | \n
\n\n| 401 | \nUnauthorized | \n
\n\n| 404 | \nBad request (there is no active subscription) | \n
\n\n
\n
This method deletes the active subscription, and clears the data cache on the server.
\n","urlObject":{"protocol":"https","path":["statsapi","subscription","active"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"dd0b85e2-77da-40b2-925e-314062b0896f","name":"Delete Subscription","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"61XXXXX2-XEX5-4XBX-81C3-14CXXXXXX721","type":"text"}],"url":"https://yourcompany.brightpattern.com/subscription/active"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1523d83e-783a-4629-af6c-fe5dc36aa61d"},{"name":"Get Dispositions","id":"20f974af-1817-4f4e-9376-0b1d5bf28a78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https:///statsapi/cfg/dispositions","description":"This method gets the disposition names for all supervised services.
\nOptional URL Parameters
\n\n- agentCanSelect = 1
\n- inbound = 1
\n- outbound = 1
\n- preview = 1
\n
\nResponse Codes
\n\n\n\n| Code | \nDescription | \n
\n\n\n\n| 200 | \nOK | \n
\n\n| 401 | \nUnauthorized | \n
\n\n
\n
This method gets either the \"true\" or the \"false\" value for agents ready to handle a specific service.
\nNote:
\n\n- No authentication or subscription is needed for this method.
\n
\nResponse
\n\n\n\n| Code | \nDescription | \n
\n\n\n\n| 200 | \nOK | \n
\n\n| True | \n\"Number of ready agents\" > 0 for the specific service (i.e., at least one agent is available) | \n
\n\n| False | \n\"Number of ready agents\" is 0 for the specific service (i.e., no agent is available) | \n
\n\n
\n
This method returns the names and internal object IDs of teams configured for the given tenant.
\nNote that in order to get the above information about a specific team, the account used for API authentication must be assigned as a supervisor to that team.
\n","urlObject":{"protocol":"https","path":["statsapi","cfg","teams"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"39c12abf-9f84-43f3-a013-df38c2e609ec","name":"Get Teams","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"url":"https://yourcompany.brightpattern.com/statsapi/cfg/teams"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": \"F4ED90FA-5A49-4D76-9487-4E41B24CA45F\",\n \"name\": \"Customer Service\"\n }\n]"}],"_postman_id":"bcf7c919-7b40-4c17-bf64-b374769bdc5e"}],"id":"cd65d7a9-61c6-4ec5-a76b-af429452bb50","description":"The Bright Pattern Contact Center Real-Time Statistics API methods are as follows.
\nNote:
\n\n","event":[{"listen":"prerequest","script":{"id":"b0474593-1e04-40e9-a148-57acc60724e2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3cc2ad67-8234-4007-8ac8-b451c11dc615","type":"text/javascript","exec":[""]}}],"_postman_id":"cd65d7a9-61c6-4ec5-a76b-af429452bb50"}],"event":[{"listen":"prerequest","script":{"id":"b46e3bf5-2de2-4a6e-baff-5f136d8d3c42","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b7160178-c0e8-43a3-a332-868785e508c8","type":"text/javascript","exec":[""]}}]}