Calculate metrics on continuous integration runs, such as GitHub Actions, Jenkins, Circle, etc.

Changed on Mar 3, 2023

post/metrics/code_checks

Request

Base URL
{{ server_url }}/v1
Auth
- HTTP bearer
- or API key in header X-API-Key
TypeScript
https://skmtc.dev/athenian/apis/title/docs/metrics/code_checks/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

metricsCodeCheckMetricID[] required

Requested metric identifiers.

date_fromstring date required

Date from when to start measuring the metrics.

date_tostring date required

Date until which to measure the metrics.

timezoneinteger

Local time zone offset in minutes, used to adjust date_from and date_to.

granularitiesGranularity[] required

The splits of the specified time range.

quantilesnumber[]

Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting.

accountinteger required

Session account ID.

split_by_check_runsboolean

Calculate metrics separately for each number of check runs in suite.

Example request

{
  "for": [
    {
      "repositories": [
        "github.com/athenianco/athenian-webapp",
        "github.com/athenianco/athenian-api"
      ],
      "pusher_groups": [
        [
          "github.com/vmarkovtsev",
          "github.com/dpordomingo"
        ],
        [
          "github.com/se7entyse7en"
        ]
      ]
    },
    {
      "repositories": [
        "github.com/athenianco/metadata",
        "github.com/athenianco/athenian-api"
      ],
      "pushers": [
        "github.com/vmarkovtsev",
        "github.com/se7entyse7en"
      ]
    }
  ],
  "metrics": [
    "chk-suites-count"
  ],
  "date_from": "2020-01-23",
  "date_to": "2021-01-24",
  "granularities": [
    "all"
  ],
  "account": 1
}

Response

Calculated metrics.

metricsCodeCheckMetricID[] required

Repeats CodeCheckMetricsRequest.metrics.

date_fromstring date required

Repeats CodeCheckMetricsRequest.date_from.