> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# Get product usage by end user

GET https://api.runtype.com/v1/analytics/end-user-usage

Get a retained, product-scoped breakdown of executions and platform spend by projected end user.

Reference: https://docs.runtype.com/api-reference/runtype-api/analytics/get-product-usage-by-end-user

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Query parameters

- `productId` (string, required)
- `productTenantId` (string, optional)
- `period` (enum, optional)
  - Allowed values: `billing_period`, `7d`, `30d`, `90d`
- `days` (integer, optional)
- `sort` (enum, optional, default: spend)
  - Allowed values: `spend`, `executions`
- `limit` (integer, optional, default: 50)

## Response

### 200

End-user usage breakdown

- `coverage` (V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaCoverage, required)
- `endUsers` (list of V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaEndUsersItems, required)
- `generatedAt` (string, required)
- `period` (V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaPeriod, required)
- `retention` (V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaRetention, required)
- `scope` (V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaScope, required)
- `tenantIds` (list of string, required)
- `totals` (V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaTotals, required)
- `unattributed` (V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaUnattributed, required)

## Errors

### 400 Bad Request Error

Validation error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 403 Forbidden Error

Insufficient permissions

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 404 Not Found Error

Feature or product not found

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

## Types

### V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaCoverage

- `attributedExecutions` (integer, required)
- `attributedSpendThousandthsCent` (integer, required)
- `unattributedExecutions` (integer, required)
- `unattributedSpendThousandthsCent` (integer, required)

### V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaEndUsersItems

- `costPerExecutionDollars` (double, required, nullable)
- `endUser` (V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaEndUsersItemsEndUser, required)
- `executions` (integer, required)
- `lastSeenAt` (string, required)
- `spendDollars` (double, required)
- `spendThousandthsCent` (integer, required)

### V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaPeriod

- `days` (integer, required)
- `endDate` (string, required)
- `startDate` (string, required)
- `preset` (enum, optional)
  - Allowed values: `billing_period`, `7d`, `30d`, `90d`

### V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaRetention

- `attributionStartedAt` (string, required, nullable)
- `earliestAvailableAt` (string, required, nullable)
- `retentionDays` (enum, required)
  - Allowed values: `93`

### V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaScope

- `productId` (string, required)
- `productTenantId` (string, required, nullable)

### V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaTotals

- `executions` (integer, required)
- `spendDollars` (double, required)
- `spendThousandthsCent` (integer, required)

### V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaUnattributed

- `executions` (integer, required)
- `spendDollars` (double, required)
- `spendThousandthsCent` (integer, required)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### V1AnalyticsEndUserUsageGetResponsesContentApplicationJsonSchemaEndUsersItemsEndUser

- `email` (string, required, nullable)
- `id` (string, required)
- `name` (string, required, nullable)
- `productTenantId` (string, required, nullable)

## Examples

**Response**

```json
{
  "coverage": {
    "attributedExecutions": 1,
    "attributedSpendThousandthsCent": 1,
    "unattributedExecutions": 1,
    "unattributedSpendThousandthsCent": 1
  },
  "endUsers": [
    {
      "costPerExecutionDollars": 1.1,
      "endUser": {
        "email": "string",
        "id": "string",
        "name": "string",
        "productTenantId": "string"
      },
      "executions": 1,
      "lastSeenAt": "string",
      "spendDollars": 1.1,
      "spendThousandthsCent": 1
    }
  ],
  "generatedAt": "string",
  "period": {
    "days": 1,
    "endDate": "string",
    "startDate": "string",
    "preset": "billing_period"
  },
  "retention": {
    "attributionStartedAt": "string",
    "earliestAvailableAt": "string",
    "retentionDays": 93
  },
  "scope": {
    "productId": "string",
    "productTenantId": "string"
  },
  "tenantIds": [
    "string"
  ],
  "totals": {
    "executions": 1,
    "spendDollars": 1.1,
    "spendThousandthsCent": 1
  },
  "unattributed": {
    "executions": 1,
    "spendDollars": 1.1,
    "spendThousandthsCent": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/analytics/end-user-usage"

querystring = {"productId":"productId"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/analytics/end-user-usage?productId=productId';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/analytics/end-user-usage?productId=productId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/analytics/end-user-usage?productId=productId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.runtype.com/v1/analytics/end-user-usage?productId=productId")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.runtype.com/v1/analytics/end-user-usage?productId=productId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/analytics/end-user-usage?productId=productId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/analytics/end-user-usage?productId=productId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```