How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Athenian

Athenian metrics API

The metrics API from Athenian — 7 operation(s) for metrics.

Documentation Provider Profile APIs.io OpenAPI GitHub

Athenian metrics API is one of 15 APIs that Athenian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metrics. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 7 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version 2.1.86.

Requests are made against a single base URL, {{ server_url }}/v1.

7 operations 7 paths 56 schemas 7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.1.86
Base URL
https://api.athenian.co/v1
Authentication
API Key, HTTP Bearer
Contact
the administrator by email
License
CC-BY-4.0
Resource Areas
1

Authentication & Security 2

Athenian metrics API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (apiKeyAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • apiKeyAuth — Authorization by the value of X-API-Key header aka API token. The tokens are user- and account-specific. Create them by calling /token/create. The server autom…
  • bearerAuth — Regular JSON Web Token authorization powered by Auth0. The server expects an Authorization: Bearer header and checks by sending it to Auth0. Visit [{{ serverur…

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 POST. Each is listed below with its method, path, parameters, and response codes.

metrics 7
POST
/metrics/code_bypassing_prs
Measure the amount of code that was pushed outside of pull requests.
calc_code_bypassing_prs body → 200400403404422
POST
/metrics/code_checks
Calculate metrics on continuous integration runs, such as GitHub Actions, Jenkins, Circle, etc.
calc_metrics_code_checks body → 200400403404422
POST
/metrics/deployments
Calculate metrics on deployments submitted by /events/deployments.
calc_metrics_deployments body → 200400403404422
POST
/metrics/developers
Calculate metrics over developer activities.
calc_metrics_developers body → 200400403404422424
POST
/metrics/jira
Calculate metrics over JIRA issue activities.
calc_metrics_jira_linear body → 200400403404422424
POST
/metrics/pull_requests
Calculate linear metrics over PRs.
calc_metrics_prs body → 200400403404422424
POST
/metrics/releases
Calculate linear metrics over releases.
calc_metrics_releases body → 200400403404422424

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are JIRAMetricsRequest (17 properties), ReleaseMetricsRequest (13 properties), ForSetDeployments (11 properties), ForSetPullRequests (10 properties). Each schema is shown below with its type and property counts.

WithBothJiraAndJiragroups
object
An object having both jira and jiragroups fields.
2 properties 2 required
CalculatedPullRequestMetrics
object
Response from /metrics/pullrequests. The dates start from datefrom and end earlier or equal to dateto. The order of the items is not guaranteed to match any ex…
8 properties 6 required
CodeFilter
object
Filter for revealing code bypassing PRs.
9 properties 5 required
RepositoryID
string
Repository name which uniquely identifies any repository in any service provider. The format matches the repository URL without the protocol part. No ".git" sh…
JIRAMetricID
string
Currently supported JIRA activity metrics. jira-open - number of issues active by the end of the time interval. jira-resolved - number of issues closed in the…
DeploymentMetricsRequest
object
Request body of /metrics/deployments, the deployments selector.
8 properties 6 required
ForSetCodeChecks
object
Filters for /metrics/codechecks and /histograms/codechecks. Achieve the best performance by packing all your filters in a single ForSetCodeChecks instead of se…
8 properties 1 required
DeveloperMetricID
string
Currently supported developer metric types. dev-commits-pushed: how many commits were pushed. dev-lines-changed: how many lines were either inserted or removed…
CalculatedDeveloperMetricsItem
object
Measured developer metrics for each DeveloperMetricsRequest.for. Each repository group maps to a distinct CalculatedDeveloperMetricsItem.
3 properties 3 required
CalculatedLinearMetricValues
object
5 properties 2 required
CalculatedJIRAMetricValues
object
Calculated JIRA metrics for a specific granularity.
5 properties 2 required
DeploymentMetricID
string
Supported deployment metrics. dep-count - number of deployments in the time period. dep-duration-all - average deployment procedure time - the difference betwe…
Quantiles
array
Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting.
JIRAFilter
object
Filters related to JIRA traits. The aggregation between each filter type is AND.
8 properties
CalculatedDeveloperMetrics
object
Response of /metrics/developers. The dates start from datefrom and end earlier or equal to dateto. The order of the items is not guaranteed to match any expect…
6 properties 5 required
ForSetDeployments
object
Filters for /metrics/deployments. Nothing is strictly required. Achieve the best performance by packing all your filters in a single ForSetDeployments instead…
11 properties
CodeCheckMetricsRequest
object
Request for calculating metrics on top of code check runs (CI) data.
9 properties 6 required
MissingSettingsError
JIRAMetricsRequest
object
Request body of /metrics/jira.
17 properties 6 required
TimeZone
integer
Local time zone offset in minutes, used to adjust datefrom and dateto.
PullRequestMetricsRequest
object
Request for calculating metrics on top of pull requests data.
10 properties 7 required
GenericError
object
5 properties 3 required
DeveloperID
string
User name which uniquely identifies any developer on any service provider. The format matches the profile URL without the protocol part.
JIRAFilterWith
object
Group of JIRA issue participant names split by role.
3 properties
JIRAStatusCategory
string
The category of a JIRA issue status.
IndexedGroups
array
Lists of indexes in repositories or developers that define independent groups that must be processed individually. The groups may have intersections.
ReleaseMetricsRequest
object
Request of /metrics/releases to calculate metrics on releases.
13 properties 6 required
CalculatedCodeCheckMetricsItem
object
Series of calculated metrics for a specific set of repositories and commit authors.
5 properties 2 required
CodeCheckMetricID
string
The mentioned terms such as "check suite" and "check run" belong to [the official documentation on GitHub](https://docs.github.com/en/rest/guides/getting-start…
DeveloperSet
array
A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored.
ForSetDevelopers
object
Filter for /metrics/developers. Achieve the best performance by packing all your filters in a single ForSetDevelopers instead of sending multiple ForSetDevelop…
7 properties 2 required
CalculatedJIRAMetrics
array
Response from /metrics/jira. The order of the items is not guaranteed to match any expectations.
ReleaseWith
object
Release contribution roles. The aggregation is OR everywhere. It is possible to mention whole teams using the syntax {id} where id is a team identifier (see /t…
3 properties
CalculatedReleaseMetrics
array
Response from /metrics/releases. The order of the items is not guaranteed to match any expectations.
RepositorySet
array
Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.
CalculatedDeploymentMetric
object
Calculated metrics for a deployments group.
4 properties 4 required
PullRequestMetricID
string
Currently supported PR metric types. pr-wip-time: average time spent in Work In Progress stage. pr-wip-time-below-threshold-ratio: ratio of PRs with a pr-wip-t…
JIRAGroups
array
Calculate metrics separately for each JIRA Filter in the list. Not compatible with jira field.
CalculatedPullRequestMetricsItem
object
Series of calculated metrics for a specific set of repositories and developers.
3 properties 2 required
TimeDuration
string
Time duration value.
Granularity
string
How often the metrics are reported. The value must satisfy the following regular expression: /^all|(([1-9]\d )?(aligned )?(day|week|month|year))$/. "all" produ…
ReleaseMetricID
string
Currently supported release metric types. release-count - number of all releases in the time interval. release-tag-count - number of releases by tag in the tim…
DeploymentWith
object
Deployment contribution roles. The aggregation is OR everywhere. It is possible to mention whole teams using the syntax {id} where id is a team identifier (see…
3 properties
Granularities
array
The splits of the specified time range.
NoSourceDataError
ForSetPullRequests
object
Filter for /metrics/pullrequests and /histograms/pullrequests. Achieve the best performance by packing all your filters in a single ForSetPullRequests instead…
10 properties
CalculatedReleaseMetric
object
Calculated release metric values.
7 properties 4 required
PullRequestWith
object
Triage PRs by various developer participation. The aggregation is OR between the participation groups and OR within each group. For example, if our request is…
7 properties
CalculatedCodeCheckMetrics
object
Response from /metrics/codechecks. The dates start from datefrom and end earlier or equal to dateto. The order of the items is not guaranteed to match any expe…
8 properties 5 required
InvalidRequestError
ReleaseMatchStrategy
string
Release workflow choice: how we should detect releases. branch: merges to certain branches are considered releases and nothing else. event: releases are manual…
CodeBypassingPRsMeasurement
object
Statistics about code pushed outside of pull requests in a certain time interval.
5 properties 5 required
MeasuredCodeBypassingPRs
array
Statistics about code pushed outside of pull requests.
CalculatedDeploymentMetrics
array
Response from /metrics/deployments, metrics calculated for each selected deployments group. The order of the items is not guaranteed to match any expectations.
DeveloperMetricsRequest
object
Request for calculating metrics on top of developer activities.
7 properties 6 required
CommitPushers
array
Check runs must be triggered by commits pushed by these people. When it is impossible to determine who pushed, e.g. in legacy API based checks, they are commit…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

athenian-metrics-api-openapi.yml Raw ↑

Other APIs Athenian publishes across the network.

Athenian align API
AE Profile APIs.io
Athenian events API
AE Profile APIs.io
Athenian filter API
AE Profile APIs.io
Athenian get API
AE Profile APIs.io
Athenian histograms API
AE Profile APIs.io
Athenian integrations API
AE Profile APIs.io
Athenian pagination API
AE Profile APIs.io
Athenian registration API
AE Profile APIs.io
Athenian reposet API
AE Profile APIs.io
Athenian security API
AE Profile APIs.io
Athenian settings API
AE Profile APIs.io
Athenian team API
AE Profile APIs.io
#Metrics
← Back to A APIs
API Details
ID
athenian:athenian-metrics-api
Base URL
https://api.athenian.co/v1
Docs
https://github.com/athenianco/api-spec
Provider
Athenian
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=athenian-metrics-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/athenian-metrics-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Athenian metrics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.