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

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

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

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

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

5 operations 3 paths 15 schemas 1 DELETE2 GET1 POST1 PUT

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 align 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 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

align 5
POST
/goal_template/create
👤 Create a goal template.
create_goal_template body → 200400
DELETE
/goal_template/{id}
👤 Delete a goal template.
delete_goal_template 1 param → 200404
GET
/goal_template/{id}
Retrieve a goal template.
get_goal_template 1 param → 200404
PUT
/goal_template/{id}
👤 Update a goal template.
update_goal_template 1 param body → 200400404
GET
/goal_templates/{id}
List the goal templates for the account.
list_goal_templates 2 params → 200404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are GoalTemplate (6 properties), GenericError (5 properties), GoalTemplateCreateRequest (5 properties), GoalTemplateUpdateRequest (4 properties). Each schema is shown below with its type and property counts.

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…
GoalTemplateCreateRequest
object
Goal template creation request body.
5 properties 3 required
GenericError
object
5 properties 3 required
CreatedIdentifier
object
1 property 1 required
GoalMetricParams
object
The parameters used to compute metric for the goal.
1 property
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…
GoalTemplate
object
A template to generate a goal.
6 properties 4 required
TimeDuration
string
Time duration value.
GoalTemplateName
string
Name of the template.
GoalTemplateUpdateRequest
object
Goal template update request body. A missing property means removal.
4 properties 2 required
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…
InvalidRequestError
GoalTemplateList
array
List of goal templates.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

athenian-align-api-openapi.yml Raw ↑

Other APIs Athenian publishes across the network.

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