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
130
131
132
133
134

# \TagApiControllerApi

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

| Method                                                                        | HTTP request                                              | Description                                                                                             |
| ----------------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| [**get_tag_names_using_get**](TagApiControllerApi.md#get_tag_names_using_get) | **Get** /spm-reports/api/v3/apps/{appIds}/tagNames        | Gets tag names for the given application identifiers appearing in the given time frame.                 |
| [**get_using_get2**](TagApiControllerApi.md#get_using_get2)                   | **Get** /spm-reports/api/v3/apps/{appIds}/metrics/filters | Gets values for specified tags for the given application identifiers appearing in the given time frame. |
| [**get_using_get3**](TagApiControllerApi.md#get_using_get3)                   | **Get** /spm-reports/api/v3/apps/{appIds}/tags            | Gets values for specified tags for the given application identifiers appearing in the given time frame. |


# **get_tag_names_using_get**
> ::models::TagNamesResponse get_tag_names_using_get(ctx, app_ids, optional)
Gets tag names for the given application identifiers appearing in the given time frame.

### Required Parameters

| Name         | Type                       | Description                           | Notes                    |
| ------------ | -------------------------- | ------------------------------------- | ------------------------ |
| **ctx**      | **context.Context**        | context containing the authentication | nil if no authentication |
| **app_ids**  | **String**                 | appIds                                |
| **optional** | **map[string]interface{}** | optional parameters                   | nil if no parameters     |

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

| Name        | Type       | Description | Notes              |
| ----------- | ---------- | ----------- | ------------------ |
| **app_ids** | **String** | appIds      |
| **from**    | **i64**    | from        |
| **to**      | **i64**    | to          |
| **metrics** | **bool**   | metrics     | [default to true]  |
| **logs**    | **bool**   | logs        | [default to true]  |
| **events**  | **bool**   | events      | [default to false] |
| **rum**     | **bool**   | rum         | [default to true]  |

### Return type

[**::models::TagNamesResponse**](TagNamesResponse.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)

# **get_using_get2**
> ::std::collections::HashMap<String, ::models::Dimension> get_using_get2(ctx, app_ids, tag, optional)
Gets values for specified tags for the given application identifiers appearing in the given time frame.

### Required Parameters

| Name         | Type                               | Description                           | Notes                    |
| ------------ | ---------------------------------- | ------------------------------------- | ------------------------ |
| **ctx**      | **context.Context**                | context containing the authentication | nil if no authentication |
| **app_ids**  | **String**                         | appIds                                |
| **tag**      | [**Vec&lt;String&gt;**](String.md) | tag                                   |
| **optional** | **map[string]interface{}**         | optional parameters                   | nil if no parameters     |

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

| Name        | Type                               | Description | Notes              |
| ----------- | ---------------------------------- | ----------- | ------------------ |
| **app_ids** | **String**                         | appIds      |
| **tag**     | [**Vec&lt;String&gt;**](String.md) | tag         |
| **from**    | **i64**                            | from        |
| **to**      | **i64**                            | to          |
| **metrics** | **bool**                           | metrics     | [default to true]  |
| **logs**    | **bool**                           | logs        | [default to true]  |
| **events**  | **bool**                           | events      | [default to false] |
| **rum**     | **bool**                           | rum         | [default to true]  |

### Return type

[**::std::collections::HashMap<String, ::models::Dimension>**](Dimension.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)

# **get_using_get3**
> ::std::collections::HashMap<String, ::models::Dimension> get_using_get3(ctx, app_ids, tag, optional)
Gets values for specified tags for the given application identifiers appearing in the given time frame.

### Required Parameters

| Name         | Type                               | Description                           | Notes                    |
| ------------ | ---------------------------------- | ------------------------------------- | ------------------------ |
| **ctx**      | **context.Context**                | context containing the authentication | nil if no authentication |
| **app_ids**  | **String**                         | appIds                                |
| **tag**      | [**Vec&lt;String&gt;**](String.md) | tag                                   |
| **optional** | **map[string]interface{}**         | optional parameters                   | nil if no parameters     |

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

| Name        | Type                               | Description | Notes              |
| ----------- | ---------------------------------- | ----------- | ------------------ |
| **app_ids** | **String**                         | appIds      |
| **tag**     | [**Vec&lt;String&gt;**](String.md) | tag         |
| **from**    | **i64**                            | from        |
| **to**      | **i64**                            | to          |
| **metrics** | **bool**                           | metrics     | [default to true]  |
| **logs**    | **bool**                           | logs        | [default to true]  |
| **events**  | **bool**                           | events      | [default to false] |
| **rum**     | **bool**                           | rum         | [default to true]  |

### Return type

[**::std::collections::HashMap<String, ::models::Dimension>**](Dimension.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)