fastly-api 15.0.0

Fastly API client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

# AiRuntimeControlUsageMetricsApi

> [!NOTE]
> All URIs are relative to `https://api.fastly.com`

Method | HTTP request | Description
------ | ------------ | -----------
[**arc_export_usage_metrics**](AiRuntimeControlUsageMetricsApi.md#arc_export_usage_metrics) | **GET** /ai-runtime-control/v1/usage-metrics/export | Export usage metrics
[**arc_get_usage_metrics**](AiRuntimeControlUsageMetricsApi.md#arc_get_usage_metrics) | **GET** /ai-runtime-control/v1/usage-metrics | Get usage metrics



## arc_export_usage_metrics

Returns usage metrics for AI Runtime Control requests. Accepts the same filter parameters as [get usage metrics](#arc-get-usage-metrics), except `sort` and `granularity`, which aren't supported here.  Set the `Accept` header to `text/csv` to receive a CSV file download instead of a JSON response. In the CSV output, the column named `time` corresponds to the `date` field in the JSON response. 

```rust
let cfg = &Configuration::default();
let params = ArcExportUsageMetricsParams {
    // parameters
};
arc_export_usage_metrics(cfg, params)
```

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key** | Option\<**String**> | Filter results to a specific virtual key ID. |  |
**provider** | Option\<**String**> | Filter results by AI provider connection ID. |  |
**model** | Option\<**String**> | Filter results by AI model identifier. |  |
**from** | Option\<**String**> | The start of the time range, in RFC 3339 format. |  |
**to** | Option\<**String**> | The end of the time range, in RFC 3339 format. Defaults to now. |  |

### Return type

[**crate::models::ArcUsageMetricsResponse**](ArcUsageMetricsResponse.md)

### Authorization

[token](../README.md#token)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/csv, application/problem+json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


## arc_get_usage_metrics

Returns usage metrics for AI Runtime Control requests, including request counts, session counts, input token counts, and output token counts.

```rust
let cfg = &Configuration::default();
let params = ArcGetUsageMetricsParams {
    // parameters
};
arc_get_usage_metrics(cfg, params)
```

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**key** | Option\<**String**> | Filter results to a specific virtual key ID. |  |
**provider** | Option\<**String**> | Filter results by AI provider connection ID. |  |
**model** | Option\<**String**> | Filter results by AI model identifier. |  |
**from** | Option\<**String**> | The start of the time range, in RFC 3339 format. |  |
**to** | Option\<**String**> | The end of the time range, in RFC 3339 format. Defaults to now. |  |
**granularity** | Option\<**String**> | The time granularity to aggregate usage by. |  |[default to daily]
**sort** | Option\<**String**> | Sort field. Prefix with `-` for descending order (e.g., `sort=-date`).  |  |[default to date]

### Return type

[**crate::models::ArcUsageMetricsResponse**](ArcUsageMetricsResponse.md)

### Authorization

[token](../README.md#token)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)