Fathom Analytics API

https://usefathom.com/docs/api-reference/
Admin
Fathom Analytics API allows you to programmatically manage your Fathom account, control sites and...
Tokens:1,607
Snippets:17
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Authenticate API Request using Curl

Source: https://usefathom.com/docs/api-reference/authentication

This example demonstrates how to authenticate an API request to the Usefathom API using the `curl` command. It requires the `Authorization` header with your API token. The output will be account information if authentication is successful.

```curl
curl https://api.usefathom.com/v1/account \
  -H "Authorization: Bearer API_TOKEN_HERE"
```

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

### Error Response Example (JSON)

Source: https://usefathom.com/docs/api-reference/errors

This example demonstrates the expected JSON payload when an error occurs during an API request. It includes a single 'error' key with a descriptive error message. Ensure the 'Accept: application/json' header is set to receive this format.

```json
{
    "error": "This token doesn't have permission to access this endpoint"
}
```

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

### List Resources with Pagination

Source: https://usefathom.com/docs/api-reference/pagination

All top-level API resources offer list methods that support cursor-based pagination. You can navigate through records using `starting_after` or `ending_before` parameters.

```APIDOC
## GET /api/resources

### Description
Fetches a list of resources with support for cursor-based pagination.

### Method
GET

### Endpoint
/api/resources

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - A limit on the number of objects to be returned, between 1 and 100. Defaults to 10.
- **starting_after** (string) - Optional - A cursor for pagination. Returns objects created after the specified object ID.
- **ending_before** (string) - Optional - A cursor for pagination. Returns objects created before the specified object ID.

### Request Example
```
GET /api/resources?limit=20&starting_after=some_object_id
```

### Response
#### Success Response (200)
- **data** (array) - A list of resource objects.
- **has_more** (boolean) - Indicates if there are more results available.

#### Response Example
```json
{
  "data": [
    {
      "id": "resource_1",
      "created_at": "2023-01-01T10:00:00Z"
    },
    {
      "id": "resource_2",
      "created_at": "2023-01-02T11:00:00Z"
    }
  ],
  "has_more": true
}
```
```

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

### API Authentication

Source: https://usefathom.com/docs/api-reference/authentication

All requests to the Fathom API must include an `Authorization` header. This header should contain your API key, prefixed with `Bearer `.

```APIDOC
## GET /v1/account

### Description
This endpoint demonstrates how to authenticate with the Fathom API by providing your API key in the Authorization header.

### Method
GET

### Endpoint
/v1/account

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```curl
curl https://api.usefathom.com/v1/account \
  -H "Authorization: Bearer API_TOKEN_HERE"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the authentication request.

#### Response Example
```json
{
  "status": "authenticated"
}
```
```

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

### API Error Handling

Source: https://usefathom.com/docs/api-reference/errors

Describes how the Fathom API handles errors, including common status codes and the structure of error response payloads.

```APIDOC
## API Error Handling

### Description
When an error is detected in a request, the Fathom API will return either an HTTP 400 (Bad Request) or 401 (Unauthorized) status code. The response body will be a JSON object containing a single key, `error`, with a string value describing the error message.

Ensure that the `Accept: application/json` header is set in your request to receive error details in JSON format.

### Method
Applies to all HTTP methods (GET, POST, PUT, DELETE, etc.)

### Endpoint
Applies to all API endpoints.

### Parameters
N/A

### Request Example
N/A

### Response
#### Error Response (400 or 401)
- **error** (string) - A descriptive message explaining the reason for the error.

#### Response Example
```json
{
    "error": "This token doesn't have permission to access this endpoint"
}
```
```
Tokens:
Raw