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

Athenian histograms API

The histograms API from Athenian — 3 operation(s) for histograms.

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

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

This API exposes 3 operations across 3 paths, and defines 42 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.

3 operations 3 paths 42 schemas 3 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
License
CC-BY-4.0
Resource Areas
1

Authentication & Security 2

Athenian histograms 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 3

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

histograms 3
POST
/histograms/code_checks
Calculate histograms on continuous integration runs, such as GitHub Actions, Jenkins, Circle, etc.
calc_histogram_code_checks body → 200400403404422
POST
/histograms/jira
Calculate histograms over JIRA issue activities.
calc_histogram_jira body → 200400403404422
POST
/histograms/pull_requests
Calculate histograms over PR distributions.
calc_histogram_prs body → 200400403404422424

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are JIRAEpicIssueCommon (19 properties), JIRAHistogramsRequest (14 properties), ForSetPullRequests (10 properties), PullRequestHistogramsRequest (9 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
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…
JIRAEpicChild
object
Details about a JIRA issue contained in an epic.
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…
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
JIRAHistogramDefinition
object
Histogram parameters: topic, bins.
4 properties 1 required
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
MissingSettingsError
JIRAEpic
object
Details about a JIRA epic together with its child issues.
TimeZone
integer
Local time zone offset in minutes, used to adjust datefrom and dateto.
CalculatedCodeCheckHistograms
array
Response from /histograms/codechecks.
GenericError
object
5 properties 3 required
HistogramScale
string
X axis scale: linear or logarithmic.
DeveloperID
string
User name which uniquely identifies any developer on any service provider. The format matches the profile URL without the protocol part.
CalculatedPullRequestHistograms
array
Response from /histograms/pullrequests.
JIRAFilterWith
object
Group of JIRA issue participant names split by role.
3 properties
JIRAStatusCategory
string
The category of a JIRA issue status.
CalculatedJIRAHistogram
object
Calculated histogram over JIRA issue activities.
6 properties 5 required
IndexedGroups
array
Lists of indexes in repositories or developers that define independent groups that must be processed individually. The groups may have intersections.
CalculatedCodeCheckHistogram
object
Calculated histogram over code checks (CI).
6 properties 6 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.
CodeCheckHistogramDefinition
object
Histogram parameters: topic, bins.
4 properties 1 required
RepositorySet
array
Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.
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…
JIRAHistogramsRequest
object
Request of /histograms/jira.
14 properties 5 required
CalculatedJIRAHistograms
array
Response from /histograms/jira.
JIRAGroups
array
Calculate metrics separately for each JIRA Filter in the list. Not compatible with jira field.
TimeDuration
string
Time duration value.
JIRAComment
object
3 properties 3 required
CodeCheckHistogramsRequest
object
Request of /histograms/codechecks.
8 properties 5 required
Interquartile
object
Middle 50% range.
2 properties 2 required
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
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
PullRequestHistogramDefinition
object
Histogram parameters: topic, bins.
4 properties 1 required
InvalidRequestError
PullRequestHistogramsRequest
object
Request of /histograms/pullrequests.
9 properties 6 required
JIRAEpicIssueCommon
object
Common properies if a JIRA issue or epic.
19 properties 12 required
CalculatedPullRequestHistogram
object
Calculated histogram over PR activities.
6 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-histograms-api-openapi.yml Raw ↑

Other APIs Athenian publishes across the network.

Athenian align API
Athenian events API
Athenian filter API
Athenian get API
Athenian integrations API
Athenian metrics API
Athenian pagination API
Athenian registration API
Athenian reposet API
Athenian security API
Athenian settings API
Athenian team API
Where this information came from

This is an independent, third-party profile of Athenian histograms 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.