Skip to content

Latest commit

 

History

History
288 lines (218 loc) · 11.8 KB

TagApiControllerApi.md

File metadata and controls

288 lines (218 loc) · 11.8 KB

TagApiControllerApi

All URIs are relative to /

Method HTTP request Description
getTagNamesUsingGET GET /spm-reports/api/v3/apps/{appIds}/tagNames Gets tag names for the given application identifiers appearing in the given time frame.
getTagsGroupedByIdUsingGET1 GET /spm-reports/api/v3/apps/{appIds}/grouped Gets tag names grouped by application id.
getUsingGET 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.
getUsingGET1 GET /spm-reports/api/v3/apps/{appIds}/tags Gets values for specified tags for the given application identifiers appearing in the given time frame.

getTagNamesUsingGET

TagNamesResponse getTagNamesUsingGET(appIds, from, to, metrics, logs, events, rum)

Gets tag names for the given application identifiers appearing in the given time frame.

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.TagApiControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

TagApiControllerApi apiInstance = new TagApiControllerApi();
String appIds = "appIds_example"; // String | appIds
Long from = 789L; // Long | from
Long to = 789L; // Long | to
Boolean metrics = true; // Boolean | metrics
Boolean logs = true; // Boolean | logs
Boolean events = false; // Boolean | events
Boolean rum = true; // Boolean | rum
try {
    TagNamesResponse result = apiInstance.getTagNamesUsingGET(appIds, from, to, metrics, logs, events, rum);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TagApiControllerApi#getTagNamesUsingGET");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appIds String appIds
from Long from [optional]
to Long to [optional]
metrics Boolean metrics [optional] [default to true]
logs Boolean logs [optional] [default to true]
events Boolean events [optional] [default to false]
rum Boolean rum [optional] [default to true]

Return type

TagNamesResponse

Authorization

api_key

HTTP request headers

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

getTagsGroupedByIdUsingGET1

TagsGroupedResponse getTagsGroupedByIdUsingGET1(appIds, tag, from, to, metrics, logs, events, rum)

Gets tag names grouped by application id.

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.TagApiControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

TagApiControllerApi apiInstance = new TagApiControllerApi();
String appIds = "appIds_example"; // String | appIds
List<String> tag = Arrays.asList("tag_example"); // List<String> | tag
Long from = 789L; // Long | from
Long to = 789L; // Long | to
Boolean metrics = true; // Boolean | metrics
Boolean logs = true; // Boolean | logs
Boolean events = false; // Boolean | events
Boolean rum = true; // Boolean | rum
try {
    TagsGroupedResponse result = apiInstance.getTagsGroupedByIdUsingGET1(appIds, tag, from, to, metrics, logs, events, rum);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TagApiControllerApi#getTagsGroupedByIdUsingGET1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appIds String appIds
tag List<String> tag
from Long from [optional]
to Long to [optional]
metrics Boolean metrics [optional] [default to true]
logs Boolean logs [optional] [default to true]
events Boolean events [optional] [default to false]
rum Boolean rum [optional] [default to true]

Return type

TagsGroupedResponse

Authorization

api_key

HTTP request headers

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

getUsingGET

Map<String, Dimension> getUsingGET(appIds, tag, from, to, metrics, logs, events, rum)

Gets values for specified tags for the given application identifiers appearing in the given time frame.

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.TagApiControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

TagApiControllerApi apiInstance = new TagApiControllerApi();
String appIds = "appIds_example"; // String | appIds
List<String> tag = Arrays.asList("tag_example"); // List<String> | tag
Long from = 789L; // Long | from
Long to = 789L; // Long | to
Boolean metrics = true; // Boolean | metrics
Boolean logs = true; // Boolean | logs
Boolean events = false; // Boolean | events
Boolean rum = true; // Boolean | rum
try {
    Map<String, Dimension> result = apiInstance.getUsingGET(appIds, tag, from, to, metrics, logs, events, rum);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TagApiControllerApi#getUsingGET");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appIds String appIds
tag List<String> tag
from Long from [optional]
to Long to [optional]
metrics Boolean metrics [optional] [default to true]
logs Boolean logs [optional] [default to true]
events Boolean events [optional] [default to false]
rum Boolean rum [optional] [default to true]

Return type

Map<String, Dimension>

Authorization

api_key

HTTP request headers

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

getUsingGET1

Map<String, Dimension> getUsingGET1(appIds, tag, from, to, metrics, logs, events, rum)

Gets values for specified tags for the given application identifiers appearing in the given time frame.

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.TagApiControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

TagApiControllerApi apiInstance = new TagApiControllerApi();
String appIds = "appIds_example"; // String | appIds
List<String> tag = Arrays.asList("tag_example"); // List<String> | tag
Long from = 789L; // Long | from
Long to = 789L; // Long | to
Boolean metrics = true; // Boolean | metrics
Boolean logs = true; // Boolean | logs
Boolean events = false; // Boolean | events
Boolean rum = true; // Boolean | rum
try {
    Map<String, Dimension> result = apiInstance.getUsingGET1(appIds, tag, from, to, metrics, logs, events, rum);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TagApiControllerApi#getUsingGET1");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appIds String appIds
tag List<String> tag
from Long from [optional]
to Long to [optional]
metrics Boolean metrics [optional] [default to true]
logs Boolean logs [optional] [default to true]
events Boolean events [optional] [default to false]
rum Boolean rum [optional] [default to true]

Return type

Map<String, Dimension>

Authorization

api_key

HTTP request headers

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