{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"6"},"outline":{"value":"false"},"style":{"value":"none"},"type":{"value":"list"},"printable":{"value":"true"}},"macroMetadata":{"macroId":{"value":"5dd05f04-1101-4d79-8ad8-534df241c9f9"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"60491a61-f03b-4bb3-b566-3024b6ba1634"}},{"type":"rule"},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"All the requests work as jobs, they can be requested then they are in the background generated and can be retrieved after through a download link in CSV format.","type":"text"}]}]},{"type":"panel","attrs":{"panelIconId":"2139","panelIcon":":information_source:","panelIconText":"ℹ️","panelColor":"#E6FCFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"The contents of the analytics are explained here: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://unique-ch.atlassian.net/wiki/spaces/PUB/pages/445907062"}},{"text":" ","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Access Token & URL","type":"text"}]},{"type":"paragraph","content":[{"text":"You can see here how to get an access token and the URL: ","type":"text"}]},{"type":"paragraph","content":[{"text":"How to get a Token for our APIs","type":"text","marks":[{"type":"link","attrs":{"href":"https://unique-ch.atlassian.net/wiki/spaces/PUB/pages/577929672"}}]},{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"About these APIs","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"excerpt-include","parameters":{"macroParams":{"":{"value":"APIs & Integrations"},"name":{"value":"internal-api-warning"},"nopanel":{"value":"true"}},"macroMetadata":{"macroId":{"value":"75d6de84-4200-4911-a731-338f5a645aed"},"schemaVersion":{"value":"1"},"title":"Insert excerpt"}},"localId":"7f014021-c934-4820-bcd4-0f835f549ab1"}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Start the job","type":"text"}]},{"type":"paragraph","content":[{"text":"Each job needs to define a ","type":"text"},{"text":"startDate ","type":"text","marks":[{"type":"strong"}]},{"text":"and ","type":"text"},{"text":"endDate","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Only in that time interval data will be evaluated.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Chat Interactions:","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl '/analytics/chat-interactions?startDate=2024-05-03&endDate=2024-06-02' \\\n -X GET \\\n -H 'content-type: application/json' \\\n -H 'Authorization: Bearer ' ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Active Users:","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl '/analytics/active-users?startDate=2024-05-03&endDate=2024-06-02' \\\n -X GET \\\n -H 'content-type: application/json' \\\n -H 'Authorization: Bearer '","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Reference Statistics: ","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl '/analytics/reference-stat-export?startDate=2024-05-03&endDate=2024-06-02' \\\n -X GET \\\n -H 'content-type: application/json' \\\n -H 'Authorization: Bearer '","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Detailed user Interactions:","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl '/analytics/chat-interactions-detailed?startDate=2024-05-03&endDate=2024-06-02' \\\n -X GET \\\n -H 'content-type: application/json' \\\n -H 'Authorization: Bearer '","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"As response from each request you should get the the ID of the analytics order that you just placed. This Id you now need to check for the status until its finished.","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"The date range defaults to 1 day when no date parameters are provided.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Waiting on the job to finish ","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Regularly check if the job is finished. Please leave at least 10 sec between checks to not overtax the system.","type":"text"}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"There are 2 parameters skip and take to paginate through all the analytics jobs that have been ordered.","type":"text"}]}]},{"type":"paragraph"},{"type":"codeBlock","content":[{"text":"curl '/grqphql' \\\n -X POST \\\n -H 'Content-Type: application/json' \\\n -H 'authorization: Bearer ' \\\n --data '{\"query\":\"query AnalyticsOrders($orderBy: [AnalyticsOrderOrderByWithRelationInput!], $take: Int, $skip: Int) {\\\\n analyticsOrders(orderBy: $orderBy, take: $take, skip: $skip) {\\\\n updatedAt\\\\n type\\\\n stateUpdatedAt\\\\n id\\\\n state\\\\n createdBy\\\\n createdAt\\\\n configuration\\\\n companyId\\\\n }\\\\n}\",\"variables\":{\"orderBy\":[{\"createdAt\":\"desc\"}],\"skip\":0,\"take\":20}}'","type":"text"}]},{"type":"paragraph","content":[{"text":"This is what is returned so you can check the state. You can not fetch the analytics until they are done.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"data\": {\n \"analyticsOrders\": [\n {\n \"updatedAt\": \"2024-06-02T19:18:58.960Z\",\n \"type\": \"CHAT_INTERACTION\",\n \"stateUpdatedAt\": \"2024-06-02T19:18:58.959Z\",\n \"id\": \"analyticOrder_ltz4rirt5ej8v0yeu0owa5sg\", <-- this is the OrderID\n \"state\": \"DONE\", <-- This is the state to check.\n \"createdBy\": \"268834226248482823\",\n \"createdAt\": \"2024-06-02T19:18:57.753Z\",\n \"configuration\": {\n \"endDate\": \"2024-06-02T21:59:59.999Z\",\n \"startDate\": \"2024-05-02T22:00:00.000Z\"\n },\n \"companyId\": \"268834226248417287\"\n }\n ]\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Download the finished Analytics:","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl '/analytics/analytics-scheduler/download/' \\\n -X GET \\\n -H 'Accept: text/csv' \\\n -H 'Authorization: Bearer '","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"You can download the data as CSV.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Delete the requested jobs once downloaded:","type":"text"}]},{"type":"paragraph","content":[{"text":"To empty the list of completed jobs you can delete the ones that are already downloaded:","type":"text"},{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"curl '/graphql' \\\n -X POST \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: Bearer ' \\\n --data '{\"query\":\"mutation AnalyticsOrderDelete($orderId: String!) {\\\\n analyticsOrderDelete(orderId: $orderId) {\\\\n updatedAt\\\\n type\\\\n stateUpdatedAt\\\\n state\\\\n id\\\\n createdBy\\\\n createdAt\\\\n configuration\\\\n companyId\\\\n }\\\\n}\",\"variables\":{\"orderId\":\"\"}}'","type":"text"}]},{"type":"paragraph"},{"type":"rule"},{"type":"table","attrs":{"layout":"default","width":633.0,"localId":"fea074be-03e2-4fde-9bd4-3ff418cc4eec"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"#f4f5f7","rowspan":1,"colwidth":[110.0]},"content":[{"type":"paragraph","content":[{"text":"Author","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[523.0]},"content":[{"type":"paragraph","content":[{"type":"mention","attrs":{"id":"619d0e43f241500072a45f26","localId":"e7852d19-6baf-4663-a722-3f8abbeba046","text":"@Andreas Hauri"}},{"text":" ","type":"text"}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported