stcloud 0.4.0

Client package for talking to Sematext Cloud.
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

# \MetricsApi

All URIs are relative to *http://localhost*

| Method                                                                         | HTTP request                                              | Description                                     |
| ------------------------------------------------------------------------------ | --------------------------------------------------------- | ----------------------------------------------- |
| [**list_data_series_using_post1**](MetricsApi.md#list_data_series_using_post1) | **Post** /spm-reports/api/v3/apps/{appId}/metrics/data    | Get metrics data points for an app              |
| [**list_filters_using_post1**](MetricsApi.md#list_filters_using_post1)         | **Post** /spm-reports/api/v3/apps/{appId}/metrics/filters | Get metrics filters and their values for an app |
| [**list_metrics_keys_using_get1**](MetricsApi.md#list_metrics_keys_using_get1) | **Get** /spm-reports/api/v3/apps/{appId}/metrics/keys     | Get metrics keys for an app                     |
| [**list_metrics_using_get**](MetricsApi.md#list_metrics_using_get)             | **Get** /spm-reports/api/v3/apps/{appId}/metrics          | Get metrics info for an app                     |



## list_data_series_using_post1

> crate::models::GenericApiResponse list_data_series_using_post1(app_id, request_body)
Get metrics data points for an app

Default value of interval is 5m

### Parameters


| Name             | Type                                          | Description                | Required   | Notes |
| ---------------- | --------------------------------------------- | -------------------------- | ---------- | ----- |
| **app_id**       | **i64**                                       | appId                      | [required] |
| **request_body** | [**DataSeriesRequest**](DataSeriesRequest.md) | Metric data points request | [required] |

### Return type

[**crate::models::GenericApiResponse**](Generic Api Response.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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


## list_filters_using_post1

> crate::models::GenericApiResponse list_filters_using_post1(app_id, request_body)
Get metrics filters and their values for an app

Default value of interval is 5m

### Parameters


| Name             | Type                                          | Description            | Required   | Notes |
| ---------------- | --------------------------------------------- | ---------------------- | ---------- | ----- |
| **app_id**       | **i64**                                       | appId                  | [required] |
| **request_body** | [**DataSeriesRequest**](DataSeriesRequest.md) | Metric filters request | [required] |

### Return type

[**crate::models::GenericApiResponse**](Generic Api Response.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

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


## list_metrics_keys_using_get1

> crate::models::GenericApiResponse list_metrics_keys_using_get1(app_id)
Get metrics keys for an app

### Parameters


| Name       | Type    | Description | Required   | Notes |
| ---------- | ------- | ----------- | ---------- | ----- |
| **app_id** | **i64** | appId       | [required] |

### Return type

[**crate::models::GenericApiResponse**](Generic Api Response.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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


## list_metrics_using_get

> crate::models::GenericApiResponse list_metrics_using_get(app_id)
Get metrics info for an app

### Parameters


| Name       | Type    | Description | Required   | Notes |
| ---------- | ------- | ----------- | ---------- | ----- |
| **app_id** | **i64** | appId       | [required] |

### Return type

[**crate::models::GenericApiResponse**](Generic Api Response.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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