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 filter API

The filter API from Athenian — 11 operation(s) for filter.

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

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

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

11 operations 11 paths 82 schemas 11 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 filter 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 11

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

filter 11
POST
/diff/releases
Find releases between the two given ones per repository.
diff_releases body → 200400403404422
POST
/filter/code_checks
Find code check runs that match the specified query. [What a code check run is exactly.](https://docs.github.com/en/rest/guides/getting-started-with-the-checks-apiabout-check-runs)
filter_code_checks body → 200400403404422
POST
/filter/commits
Find commits that match the specified query.
filter_commits body → 200400403404422
POST
/filter/contributors
Find developers that made an action within the given timeframe.
filter_contributors body → 200400403404422
POST
/filter/deployments
List the deployments that satisfy the provided filters. We accept new deployment notifications at /events/deployments.
filter_deployments body → 200400403404422
POST
/filter/environments
List the deployment environments.
filter_environments body → 200400404422
POST
/filter/jira
Find various JIRA entities relevant to the specified date interval.
filter_jira_stuff body → 200403404
POST
/filter/labels
Find labels used in the given repositories.
filter_labels body → 200400403404422
POST
/filter/pull_requests
List pull requests that satisfy the query.
filter_prs body → 200400403404422424
POST
/filter/releases
Find releases that were published in the given time fram in the given repositories.
filter_releases body → 200400403404422424
POST
/filter/repositories
Find repositories that were updated within the given timeframe.
filter_repositories body → 200400403404422424

Schemas 82

The contract defines 82 schemas that model the data the API accepts and returns. The most detailed are PullRequest (29 properties), JIRAEpicIssueCommon (19 properties), FilterPullRequestsRequest (16 properties), FilterDeploymentsRequest (13 properties). Each schema is shown below with its type and property counts.

DeveloperSummary
object
Developer activity statistics and profile details.
5 properties 4 required
FilterReleasesRequest
object
Filters for /filter/releases.
9 properties 3 required
DeveloperSet
array
A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored.
PullRequest
object
Details of a pull request. All the attributes, stats and events correspond to "today", not dateto, except for the PR stages wip, reviewing, merging, releasing,…
29 properties 14 required
JIRAIssue
FilteredCodeCheckRun
object
Mined information about a code check run.
7 properties 6 required
TimeDuration
string
Time duration value.
JIRAComment
object
3 properties 3 required
FilterEnvironmentsRequest
object
Request body of /filter/environments. Filters for deployment environments.
5 properties 3 required
FilterLabelsRequest
object
Request body of /filter/labels. Defines the account and the repositories where to look for the labels.
2 properties 1 required
FilterPullRequestsRequest
object
Filters for /filter/pullrequests. Empty properties passes through all PRs matched by the other filters.
16 properties 5 required
FilteredRelease
object
Various information about a repository release.
13 properties 12 required
StageTimings
object
Time spent by the PR in each pipeline stage. The deployments are independent of the releases. If the release happens before the deployment, the deployment time…
5 properties 1 required
FilteredLabels
array
List of labels.
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…
IncludedDeployments
object
Mentioned deployments.
1 property
JIRAUser
object
Details about a JIRA user.
4 properties 3 required
DiffReleasesRequest
object
Request of /diff/releases. Define pairs of releases for several repositories to find the releases in between.
2 properties 2 required
Quantiles
array
Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting.
TimeZone
integer
Local time zone offset in minutes, used to adjust datefrom and dateto.
Commit
object
Information about a commit.
10 properties 8 required
IncludedJIRAIssues
object
Mentioned JIRA issues.
1 property
DiffedReleases
object
Response of /diff/releases - the found inner releases for each repository.
2 properties 2 required
CommitSignature
object
Git commit signature. It is guaranteed that login and/or name&email are present.
5 properties 2 required
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
Color
string
RGB 24-bit color in hex.
ReleaseDiff
object
Inner releases between old and new, including the latter.
3 properties 3 required
DeveloperSummaries
array
List of developer activity statistics and profile details.
ReleasePair
object
A pair of release names within the same repository.
2 properties 2 required
DeployedComponent
object
Definition of the deployed software unit.
2 properties 2 required
JIRAIssueType
object
Details about a JIRA issue type.
7 properties 7 required
FilteredEnvironment
object
Details about a deployment environment.
4 properties 4 required
NoSourceDataError
DeveloperUpdates
object
Various developer contributions statistics over the specified time period. Note: any of these properties may be missing if there was no such activity.
6 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
FilterRepositoriesRequest
object
Filters for /filter/repositories.
6 properties 3 required
PullRequestSet
object
List of pull requests together with the participant profile pictures.
2 properties 2 required
InvalidRequestError
CommitsList
object
List of commits metadata and related user details.
2 properties 2 required
JIRAPriority
object
JIRA issue priority details.
4 properties 4 required
JIRALabel
object
Details about a JIRA label.
4 properties 3 required
PullRequestStage
string
PR's modelled lifecycle stages. wip: The PR is a work-in-progress: no reviews, no review requests, not closed. reviewing: The PR is going through a review proc…
PullRequestEvent
string
PR's modelled lifecycle events. created: The PR was opened. committed: Somebody pushed a commit to the PR. reviewrequested: Somebody requested a PR review. rev…
FilterDeploymentsRequest
object
Filters to select the deployments in /filter/deployments.
13 properties 3 required
ReleasedPullRequest
object
Details about a pull request listed in /filter/releases.
7 properties 6 required
FilterJIRAStuff
object
Request of /filter/jira to retrieve epics, labels, types, priorities, users, etc.
12 properties 4 required
GenericError
object
5 properties 3 required
JIRAFilterWith
object
Group of JIRA issue participant names split by role.
3 properties
JIRAStatus
object
JIRA issue status details.
3 properties 3 required
JIRAStatusCategory
string
The category of a JIRA issue status.
PullRequestLabel
object
Pull request label.
3 properties 2 required
DeploymentConclusion
string
State of the completed deployment. Case-insensitive.
LinkedJIRAIssue
object
Brief details about a JIRA issue.
5 properties 3 required
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
JIRAEpicIssueCommon
object
Common properies if a JIRA issue or epic.
19 properties 12 required
IncludedNativeUser
object
User traits such as the avatar URL.
1 property 1 required
FilteredDeployments
object
Found deployments, response from /filter/deployments.
2 properties 2 required
FilterCommitsRequest
object
Filter for listing commits.
9 properties 5 required
JIRAEpicChild
object
Details about a JIRA issue contained in an epic.
JIRAFilter
object
Filters related to JIRA traits. The aggregation between each filter type is AND.
8 properties
DeploymentAnalysis
object
Statistics and contents of the deployment.
3 properties 1 required
IncludedNativeUsers
object
Mentioned GitHub users.
1 property 1 required
MissingSettingsError
JIRAEpic
object
Details about a JIRA epic together with its child issues.
PullRequestParticipant
object
Developer and their role in the PR.
2 properties 2 required
DeveloperID
string
User name which uniquely identifies any developer on any service provider. The format matches the profile URL without the protocol part.
JIRAFilterReturn
string
Requested chapter to return in /filter/jira. epics: Activates the epic flow. issues: Activates the issue flow. issuebodies: Include the details about filtered…
CodeCheckRunStatistics
object
Gathered statistics about a group of check runs.
12 properties 12 required
RepositorySet
array
Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.
FilterCodeChecksRequest
object
Request body of /filter/codechecks.
10 properties 4 required
FilterContributorsRequest
object
Filters for /filter/contributors.
6 properties 3 required
FilteredJIRAStuff
object
Response from /filter/jira: found JIRA epics, labels, issue types, priorities, and mentioned users.
8 properties 7 required
ReleaseSet
object
Release metadata and contributor user details.
2 properties
DeployedPullRequest
object
Brief information about a deployed pull request.
DeploymentNotification
object
Push message about a deployment. We remove unresolved components after 24h.
8 properties 5 required
FilteredEnvironments
array
List of distinct deployment environments.
FilteredLabel
object
Details about a label and some basic stats.
4 properties 3 required
DeploymentLabels
object
Arbitrary key-value metadata that associates with the deployment.
FilteredCodeCheckRuns
object
Response from /filter/codechecks, found code check runs ordered by repository name and then by title. Note: we always consider the completed run executions onl…
2 properties 2 required
DeployedRelease
object
Various information about a repository release.
12 properties 12 required
FilteredDeployment
object
Everything we know about the deployment.
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-filter-api-openapi.yml Raw ↑

Other APIs Athenian publishes across the network.

Athenian align API
Athenian events API
Athenian get API
Athenian histograms 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 filter 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.