REST API: Get Recognition Insights | Axero Documentation

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/recognition/users/641/insights?FromDate=1/1/2020&ToDate=12/31/2020

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "Points": 3271,
    "AwardedContentCount": 0,
    "KudosReceived": 0,
    "KudosGiven": 1,
    "ChallengesCount": 10,
    "RankName": "Professional",
    "RankImageUrl": "https://your-site.com/Assets/Uploaded-Photos/rank-professional.gif",
    "EarnedBadges": [
      {
        "BadgeID": 6905,
        "Title": "Taskmaster",
        "Summary": "Create 10 tasks for yourself to learn how to use the Task Manager.",
        "Description": "<p>Getting to know how to use the Task Manager is important because it allows you to stay organized. Create 10 tasks for yourself to become familiar with the technology. It's super easy and very effective in the long run!</p>",
        "ImageUrl": "https://your-site.com/Assets/Uploaded-Photos/1d439da3-b73f-471a-9354-90f7cd5b03d1.jpg",
        "ProgramID": 7089,
        "IsChallenge": false,
        "IsActive": true,
        "CanRecieveMultipleTimes": false,
        "IsVisibleOnActivityStream": false,
        "IsCompleted": false,
        "OtherUsersCompletedCount": 0
      },
      {
        "BadgeID": 6903,
        "Title": "Collaborator",
        "Summary": "Awarded to co-workers who collaborate well with others and their teams.",
        "Description": "<p>Here’s why you should collaborate with your co-workers and teams:</p>\n<p><strong>It Promotes Self-Analysis</strong></p>\n<p>Collaboration challenges people to think, articulate and receive clarity about their competencies. It serves as a mirror that gives them a glimpse of their strengths and weaknesses. Because two heads are better than one, teams work better together and plug each other’s gaps.</p>\n<p><strong>It Results in Problem Solving</strong></p>\n<p>When a variety of knowledge and skills are pooled, it creates a talent pool that is vast and more competent, able and experienced. Virtual collaboration minimizes or even eliminates the need for finances and infrastructure. Thanks to the Internet, businesses can gain better market reach and organizations with people from diverse backgrounds can thrive.</p>\n<p><strong>It Makes You Look at the Bigger Picture</strong></p>\n<p>No two people are the same, and when you have several people from different backgrounds working for you, you will need to know how to leverage those differences and identify how they can complement each other. You also need to understand that even if the project does not shape up the way you wanted it to in the end, the partnership could still achieve a great deal.</p>\n<p><strong>It Teaches</strong></p>\n<p>When your teams are collaborating, they are essentially learning new things from each other. Your organization becomes a body which encourages a culture of continuous learning, and supports that learning through opportunities for growth and development, as well as through safety nets for failures. Whenever team members collaborate, they enhance their capacity to go and grow beyond their comfort zones and take your business to new heights.</p>",
        "ImageUrl": "https://your-site.com/Assets/Uploaded-Photos/7b843443-02f0-4ab5-b4b0-929e0cea1ba7.jpg",
        "ProgramID": 7089,
        "IsChallenge": false,
        "IsActive": true,
        "CanRecieveMultipleTimes": false,
        "IsVisibleOnActivityStream": false,
        "IsCompleted": false,
        "OtherUsersCompletedCount": 0
      },
      {
        "BadgeID": 6908,
        "Title": "Event Planner",
        "Summary": "Create 3 events on any calendar in the intranet.",
        "Description": "<p>Creating events is a great way to keep track of your schedule.</p>",
        "ImageUrl": "https://your-site.com/Assets/Uploaded-Photos/2cbb618a-67a0-4f85-9dc0-86331134ac1e.jpg",
        "ProgramID": 7089,
        "IsChallenge": false,
        "IsActive": true,
        "CanRecieveMultipleTimes": false,
        "IsVisibleOnActivityStream": false,
        "IsCompleted": false,
        "OtherUsersCompletedCount": 0
      },
      {
        "BadgeID": 6901,
        "Title": "Complete your profile",
        "Summary": "To win this badge, fill out your profile, upload your photo, and set your preferences. ",
        "Description": "<p>Updating your profile is a great way for your co-workers to get to know you. Your employee profile contains fields for first and last name, company, email address, phone, address, and an \"about me\" section. You can take this even further and provide information about the teams you are a part of, projects you have worked on, and what you're working on currently.</p>",
        "ImageUrl": "https://your-site.com/Assets/Uploaded-Photos/4b66604e-2f05-48a3-a2e5-32fea1fc7043.jpg",
        "ProgramID": 7142,
        "IsChallenge": false,
        "IsActive": true,
        "CanRecieveMultipleTimes": false,
        "IsVisibleOnActivityStream": false,
        "IsCompleted": false,
        "OtherUsersCompletedCount": 0
      }
    ]
  }
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "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.