Get product usage by end user

GET

/v1/analytics/end-user-usage

GET

/v1/analytics/end-user-usage

$ curl -G https://api.runtype.com/v1/analytics/end-user-usage \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d productId=prod_9f8b7c6d5e4a3b2c1d0e \
>      -d productTenantId=tenant_12345abcde \
>      -d period=30d \
>      -d days=30 \
>      -d sort=spend \
>      -d limit=50

1 {
2   "coverage": {
3     "attributedExecutions": 12500,
4     "attributedSpendThousandthsCent": 3750000,
5     "unattributedExecutions": 3200,
6     "unattributedSpendThousandthsCent": 960000
7   },
8   "endUsers": [
9     {
10       "costPerExecutionDollars": 0.3,
11       "endUser": {
12         "email": "jane.doe@example.com",
13         "id": "user_7890abcd1234",
14         "name": "Jane Doe",
15         "productTenantId": "tenant_12345abcde"
16       },
17       "executions": 4000,
18       "lastSeenAt": "2024-06-10T15:45:00Z",
19       "spendDollars": 1200,
20       "spendThousandthsCent": 120000000
21     },
22     {
23       "costPerExecutionDollars": 0.25,
24       "endUser": {
25         "email": "john.smith@example.com",
26         "id": "user_5678efgh9012",
27         "name": "John Smith",
28         "productTenantId": "tenant_12345abcde"
29       },
30       "executions": 3000,
31       "lastSeenAt": "2024-06-09T12:30:00Z",
32       "spendDollars": 750,
33       "spendThousandthsCent": 75000000
34     }
35   ],
36   "generatedAt": "2024-06-11T08:00:00Z",
37   "period": {
38     "days": 30,
39     "endDate": "2024-06-10",
40     "startDate": "2024-05-12",
41     "preset": "30d"
42   },
43   "retention": {
44     "attributionStartedAt": "2024-03-01T00:00:00Z",
45     "earliestAvailableAt": "2024-03-01T00:00:00Z",
46     "retentionDays": 93
47   },
48   "scope": {
49     "productId": "prod_9f8b7c6d5e4a3b2c1d0e",
50     "productTenantId": "tenant_12345abcde"
51   },
52   "tenantIds": [
53     "tenant_12345abcde",
54     "tenant_67890fghij"
55   ],
56   "totals": {
57     "executions": 15700,
58     "spendDollars": 4710,
59     "spendThousandthsCent": 471000000
60   },
61   "unattributed": {
62     "executions": 3200,
63     "spendDollars": 960,
64     "spendThousandthsCent": 96000000
65   }
66 }

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

Authentication

AuthorizationBearer

API key or Clerk session token

Query parameters

productIdstringRequired>=1 character

productTenantIdstringOptional>=1 character

periodenumOptional

Allowed values:

daysintegerOptional1-93

sortenumOptionalDefaults to spend

Allowed values:

limitintegerOptional1-200Defaults to 50

Response

End-user usage breakdown

coverageobject

endUserslist of objects

generatedAtstring

periodobject

retentionobject

scopeobject

tenantIdslist of strings

totalsobject

unattributedobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error