Metrics API

This document describes the DeepScan metrics API.

You can access to the API after configuring the IP whitelist in the configuration file.

Metrics

You can get all the metrics including information about the current state of your DeepScan.

URL:

GET /api/metrics

Example response:

{
    user_count: 4,
    team_count: 3,
    rule_count: 182,
    session_count: 3,
    analyzed_loc_count: 983,
    project_cumulative_count: 29,
    project_count: 23,
    analysis_cumulative_count: 183,
    analysis_count: 179,
    analysis_analyzing_state_count: 2,
    analysis_pending_state_count: 1
}

The following metrics are available:

  • user_count: Total number of users
  • team_count: Total number of teams
  • rule_count: Total number of DeepScan rules
  • session_count: Total number of sessions
  • analyzed_loc_count: Total number of lines which is the sum of each project's analyzed LoC
  • project_cumulative_count: Total number of accumulated projects (including deleted projects)
  • project_count: Total number of current projects
  • analysis_cumulative_count: Total number of accumulated analyses (including deleted analyses)
  • analysis_count: Total number of current analyses
  • analysis_analyzing_state_count: Total number of analyses having 'Analyzing' status
  • analysis_pending_state_count: Total number of analyses having 'Pending' status