Aspects API

This document describes the APIs of Aspecta for users' aspects.

Builder: Query a user's skill(s)

Query a user's specific skill, or all skills

• Endpoint

  GET https://api.aspecta.ai/v1/aspects/builders/skills/me

• Request

  We will use the access token to identify the user. The following table lists the parameters that you can include in the skill request.

  Parameter	Description
  name	Optional string The name of the skill. It will query all skills of the user if no name specified. To know which skills are available, see builder skills.

  • The following snippet shows a sample request to query skill security of a user:

    POST /token HTTP/1.1
    Host: https://api.aspecta.ai/v1/aspects/builders/skills/me
    Content-Type: application/x-www-form-urlencoded
    Authorization: Bearer 7/Lvq3XoJkU1oNz8A82v3b6T2I
    
    name=security

    CURL Example

    curl -H "Authorization: Bearer 7/Lvq3XoJkU1oNz8A82v3b6T2I" \
    https://api.aspecta.ai/v1/aspects/builders/skills/me \
    -d "name=security"

  • The following snippet shows a sample request to query all skills of the user:

    POST /token HTTP/1.1
    Host: https://api.aspecta.ai/v1/aspects/builders/skills/me
    Content-Type: application/x-www-form-urlencoded
    Authorization: Bearer 7/Lvq3XoJkU1oNz8A82v3b6T2I

    CURL Example

    curl -H "Authorization: Bearer 7/Lvq3XoJkU1oNz8A82v3b6T2I" https://api.aspecta.ai/v1/aspects/builders/skills/me

• Response

  The builder skills of the user will be returned in the tree structure. It will returned the highest level's skills in list form, and their children skills will be contained in the children field. The highest level's skills are shown in the innermost layer of the skills sunburst chart.

  

  Fields of a skill

  Field	Description
  name	string The name of the skill. To know which skills are available, see builer skills.
  ranking	float The ranking of the skill, which represent the skill profiency ranking of all github users and the range is (0, 1], and the higher the better. null if the skill is the first level skill.
  profiency	int The profiency score of the skill. null if the skill is the first level skill.
  children	list The children skills of the skill.

  The following snippet shows a sample response:

  [
      {
          "name": "security",
          "ranking": 0.6166666666666667,
          "proficiency": 165,
          "children": [
              {
                  "name": "malware-analysis",
                  "ranking": 0.5882352941176471,
                  "proficiency": 231,
                  "children": []
              },
              {
                  "name": "authentication",
                  "ranking": 0.575,
                  "proficiency": 145,
                  "children": [
                      {
                          "name": "oauth",
                          "ranking": 0.5671641791044777,
                          "proficiency": 129,
                          "children": []
                      }
                  ]
              },
              {
                  "name": "network-security",
                  "ranking": 0.7166666666666667,
                  "proficiency": 487,
                  "children": []
              }
          ]
      },
      {
          "name": "networking",
          "ranking": 0.675,
          "proficiency": 165,
          "children": [
              {
                  "name": "routing",
                  "ranking": 0.575,
                  "proficiency": 123,
                  "children": []
              }
          ]
      }
  ]