User account¶

Endpoints¶

GET /account/¶

Authenticated account information.

{
  "id": "user_username",
  "url": "https://developer.koodous.com/analysts/user_username/",
  "username": "user_username",
  "first_name": "User first name",
  "last_name": "User last name",
  "last_login": "2022-01-14T09:21:46.431468+01:00",
  "profile": {
    "avatar": "",
    "occupation": "",
    "biography": "",
    "twitter": "",
    "is_expert": false
  },
  "settings": {
    "notify_analysis_completed": true,
    "notify_ruleset_matched": true,
    "notify_new_profile_comment": true,
    "notify_new_ruleset_comment": true,
    "notify_new_follower": true,
    "notify_new_mention": true,
    "email_analysis_completed": false,
    "email_ruleset_matched": false,
    "email_new_follower": false
  },
  "api_group": "api_corporate",
  "can_get_apks_feed": true,
  "can_get_analyses_feed": true,
  "can_get_detected_feed": true,
  "followers_count": 1,
  "followed_count": 1,
  "rulesets_count": 11,
  "created_at": "2020-01-01T00:00:00+02:00"
}

PUT /account/¶

Update analyst profile.

The analyst’s first and last name, profile and settings can be modified.

The profile information (profile) includes: avatar, occupation, biography, twitter.

Among the analyst configuration information (settings) includes the different configuration options of bool type:

• notify_analysis_completed: notify internally when an analysis is completed.

• notify_ruleset_matched: notify internally when a match is produced by an own rule.

• notify_new_profile_comment: notify internally when a comment is received on the profile.

• notify_new_ruleset_comment: notify internally when another analyst comments on an own rule.

• notify_new_follower: notify internally when you are followed by another analyst.

• notify_new_mention: notify internally when you receive a mention in a comment (apk or rule).

• email_analysis_completed: notify by email when an analysis is completed.

• email_ruleset_matched: notify by email when a rule produces a match.

• email_new_follower: notify by email when a new follower is received.

PATCH /account/¶

Update analyst profile.

The analyst’s first and last name, profile and settings can be modified.

The profile information (profile) includes: avatar, occupation, biography, twitter.

Among the analyst configuration information (settings) includes the different configuration options of bool type:

• notify_analysis_completed: notify internally when an analysis is completed.

• notify_ruleset_matched: notify internally when a match is produced by an own rule.

• notify_new_profile_comment: notify internally when a comment is received on the profile.

• notify_new_ruleset_comment: notify internally when another analyst comments on an own rule.

• notify_new_follower: notify internally when you are followed by another analyst.

• notify_new_mention: notify internally when you receive a mention in a comment (apk or rule).

• email_analysis_completed: notify by email when an analysis is completed.

• email_ruleset_matched: notify by email when a rule produces a match.

• email_new_follower: notify by email when a new follower is received.

GET /account/statistics/¶

Analyst statistics.

This contains information on the API limits according to the group to which it belongs and how it is used.

Example response:

HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "rate_limits": {
        "apk-search": {
            "limit": "15/day",
            "used": 0
        },
        "apk-detail": {
            "limit": "4/min",
            "used": 0
        },
        "apk-download": {
            "limit": "5/day",
            "used": 0
        },
        "apk-analyze": {
            "limit": "0/day",
            "used": 0
        },
        "apk-analysis": {
            "limit": "5/day",
            "used": 0
        },
        "api-usage": {
            "limit": "150/min",
            "used": 0
        }
    }
}