REST API: Get Axero Copilot Conversation Records | Axero Documentation

Request

Request Header

Optional Parameters

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/analytics/copilot/conversations

Success Response

{
            "Duration": 29.790446996688843,
            "DiscussionId": "c94c487d-ab52-490a-8aed-d761591d3499",
            "InteractionId": "0ff5bafa-bcc9-447a-a7ef-bd6dfc272bff",
            "Question": "How to request time off?",
            "Response": "Here’s how to request time off according to the latest company documentation:\n\n---\n\n## How to Request Time Off\n\n### 1. **Complete the Time Off Request Form**\n- Download the official form:\n  - [PDF Version](https://yoursite.com/spaces/252/human-resources/files/7076/time-off-request-form-sample-pdf?language=en-US)\n  - [Word Version](https://yoursite.com/spaces/252/human-resources/files/7081/time-off-request-form-sample-docx?language=en-US)\n- Fill in:\n  - Today’s date\n  - Your name\n  - Number of days or hours requested\n  - Start and end dates for your time off\n  - Reason for request (Vacation, Personal Leave, Medical Leave, etc.)\n\n### 2. **Submit the Form**\n- Submit the completed form to your manager or HR department as per your team’s standard process (email, HRIS upload, or in-person).\n\n### 3. **Approval Process**\n- Your request is subject to approval by your manager or HR.\n- You will be notified if your request is approved or rejected.\n- The form includes a section for the employer’s decision and signature.\n\n### 4. **Keep a Copy**\n- Retain a copy of the approved form for your records.\n\n---\n\n**Note:** For medical leave, additional documentation (such as a doctor’s note) may be required. For more details, refer to the [How to Request Time Off article](https://yoursite.com/spaces/252/human-resources/articles/news/10120/how-to-request-time-off).\n\nIf you need help with a specific type of leave (e.g., maternity, bereavement), let me know!",
            "Feedback": "helpful",
            "UserId": "636",
            "UserName": "Alice Romero",
            "ProfileId": "1",
            "ProfileName": "Default",
            "TimestampEnd": "1777888299.4061122",
            "TimestampStart": "1777888269.6156652",
            "DateEndISO": "2026-05-04T09:51:39.406112Z",
            "DateStartISO": "2026-05-04T09:51:09.615665Z",
            "DiscussionDateStartISO": "2026-05-04T09:50:02.180000Z",
            "References": [
                {
                    "ContentId": "10120",
                    "EntityType": "3",
                    "Relevance": "95",
                    "SpaceId": "252",
                    "Title": "How to Request Time Off",
                    "URL": "https://yoursite.com/spaces/252/human-resources/articles/news/10120/how-to-request-time-off"
                },
                {
                    "ContentId": "7076",
                    "EntityType": "14",
                    "Relevance": "90",
                    "SpaceId": "252",
                    "Title": "Time Off Request Form - Sample.pdf",
                    "URL": "https://yoursite.com/spaces/252/human-resources/files/7076/time-off-request-form-sample-pdf?language=en-US"
                },
                {
                    "ContentId": "7081",
                    "EntityType": "14",
                    "Relevance": "90",
                    "SpaceId": "252",
                    "Title": "Time Off Request Form - Sample.docx",
                    "URL": "https://yoursite.com/spaces/252/human-resources/files/7081/time-off-request-form-sample-docx?language=en-US"
                },
                {
                    "ContentId": "518",
                    "EntityType": "19",
                    "Relevance": "70",
                    "SpaceId": "252",
                    "Title": "How do I request time off for maternity?",
                    "URL": "https://yoursite.com/spaces/252/human-resources/cases/case/518"
                },
                {
                    "ContentId": "514",
                    "EntityType": "19",
                    "Relevance": "60",
                    "SpaceId": "252",
                    "Title": "Time-Off Request Forms?",
                    "URL": "https://yoursite.com/spaces/252/human-resources/cases/case/514"
                }
            ],
            "UserFeedback": {
                "FeedbackIssues": [],
                "FeedbackText": "",
                "FeedbackType": "positive"
            },
            "ResolutionSteps": [
                {
                    "Type": "search",
                    "Label": "Search: User Content",
                    "Parameters": [
                        {
                            "Name": "Keywords",
                            "Value": "request time off"
                        },
                        {
                            "Name": "Query",
                            "Value": "What is the process for requesting time off, including medical leave, vacation, or personal days? Please include any required forms, approval steps, and where to submit the request."
                        },
                        {
                            "Name": "Scope",
                            "Value": "User Content"
                        }
                    ],
                    "Warnings": [],
                    "Steps": []
                }
            ]
        }
    ],
    "InteractionCount": 0,
    "Temperature": 0.0
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required field missing",
  "ResponseData": null
}

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

• Sustained Request Rate: Do not exceed 5 API calls per second
• Sequential Processing: Wait for each request to complete before sending the next in automated workflows
• Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
• Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.