Return the current GitHub installation progress in Athenian.

get/invite/progress/{id}

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/invite/progress/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

Numeric identifier of the account that is installing GitHub.

Response

Status of fetching GitHub data to Athenian.

started_datestring date-time required

Date and time when the historical data collection began.

finished_datestring date-time nullable required

Date and time when the historical data collection ended.

ownerstring

repositoriesinteger

Number of discovered repositories.

Example response

{
  "tables": [
    {
      "fetched": 50,
      "name": "Commit",
      "total": 100
    },
    {
      "fetched": 0,
      "name": "PullRequest",
      "total": 20
    }
  ],
  "finished_date": "2020-01-23T04:56:07Z",
  "started_date": "2020-01-23T06:56:07Z",
  "owner": "vmarkovtsev",
  "repositories": 30
}

Changes

No recorded changes to this operation across all 90 revisions of this API.