Hackatime Admin API

https://hackatime.hackclub.com/api-docs/admin
Admin
Hackatime Admin API provides administrative and internal endpoints for Hackatime, allowing...
Tokens:1,283
Snippets:9
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /admin

Source: https://hackatime.hackclub.com/api-docs/admin#tag/admin

Retrieves administrative data filtered by year and month.

```APIDOC
## GET /admin

### Description
Retrieves administrative data based on the specified year and month.

### Method
GET

### Parameters
#### Query Parameters
- **year** (string) - Required - The year for the data request.
- **month** (string) - Required - The month for the data request.
```

--------------------------------

### Get quantized coding visualization for a user

Source: https://hackatime.hackclub.com/api-docs/admin#tag/admin

Retrieves per-day quantized heartbeat points and total coding seconds for a specific user. Requires year and month parameters.

```Shell
curl 'https://hackatime.hackclub.com/api/admin/v1/users/{id}/visualization/quantized?year=1&month=1' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

```JSON
{
  "days": [
    {
      "date_timestamp_s": 1704067200,
      "total_seconds": 7200,
      "points": [
        {
          "time": 1704110400,
          "lineno": 42,
          "cursorpos": 12
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /api/admin/v1/users/{id}/visualization/quantized

Source: https://hackatime.hackclub.com/api-docs/admin#tag/admin

Retrieves the quantized coding visualization data for a specific user.

```APIDOC
## GET /api/admin/v1/users/{id}/visualization/quantized

### Description
Retrieves the quantized coding visualization for a specified user.

### Method
GET

### Endpoint
/api/admin/v1/users/{id}/visualization/quantized

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the user.
```

--------------------------------

### GET /api/admin/v1/alts/candidates

Source: https://hackatime.hackclub.com/api-docs/admin#tag/admin

Retrieves pairs of users that have shared the same machine and IP address within a specified lookback window.

```APIDOC
## GET /api/admin/v1/alts/candidates

### Description
Returns pairs of users that have shared the same machine + IP address within the lookback window. Capped at 5000 candidate pairs.

### Method
GET

### Endpoint
/api/admin/v1/alts/candidates

### Parameters
#### Query Parameters
- **lookback_days** (integer) - Optional - Number of days to look back (default: 30, clamped to 1-365)

### Response
#### Success Response (200)
- **candidates** (array) - List of user pairs identified as potential alt-accounts

#### Response Example
{
  "candidates": [
    {
      "user_a_id": 42,
      "user_b_id": 43,
      "machine": "Orpheus-MacBook-Pro",
      "ip_address": "203.0.113.7",
      "user_a_first_seen_on_combo": 1710340200,
      "user_a_last_seen_on_combo": 1710946200,
      "user_b_first_seen_on_combo": 1710512400,
      "user_b_last_seen_on_combo": 1710859800
    }
  ]
}
```

--------------------------------

### GET /api/admin/v1/users/{id}/visualization/quantized

Source: https://hackatime.hackclub.com/api-docs/admin#tag/admin

Returns a per-day, quantized set of heartbeat points for a specific user within a given month, along with per-day total coding seconds.

```APIDOC
## GET /api/admin/v1/users/{id}/visualization/quantized

### Description
Returns a per-day, quantized set of heartbeat points (for the given month) plus per-day total coding seconds. Used to render a compact activity visualization.

### Method
GET

### Endpoint
/api/admin/v1/users/{id}/visualization/quantized

### Parameters
#### Path Parameters
- **id** (string) - Required - User ID

#### Query Parameters
- **year** (integer) - Required - Year (e.g. 2024)
- **month** (integer) - Required - Month (1-12)

### Response
#### Success Response (200)
- **days** (array) - List of daily activity data

#### Response Example
{
  "days": [
    {
      "date_timestamp_s": 1704067200,
      "total_seconds": 7200,
      "points": [
        {
          "time": 1704110400,
          "lineno": 42,
          "cursorpos": 12
        }
      ]
    }
  ]
}
```

--------------------------------

### List potential alt-account candidates

Source: https://hackatime.hackclub.com/api-docs/admin#tag/admin

Returns pairs of users sharing machines and IP addresses within a specified lookback window.

```Shell
curl 'https://hackatime.hackclub.com/api/admin/v1/alts/candidates?lookback_days=1' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

```JSON
{
  "candidates": [
    {
      "user_a_id": 42,
      "user_b_id": 43,
      "machine": "Orpheus-MacBook-Pro",
      "ip_address": "203.0.113.7",
      "user_a_first_seen_on_combo": 1710340200,
      "user_a_last_seen_on_combo": 1710946200,
      "user_b_first_seen_on_combo": 1710512400,
      "user_b_last_seen_on_combo": 1710859800
    }
  ]
}
```
Tokens:
Raw