Skip to content

Latest commit

 

History

History
270 lines (199 loc) · 10.3 KB

TagApiControllerApi.md

File metadata and controls

270 lines (199 loc) · 10.3 KB

*# SematextApiClientJavascript.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.
getUsingGET3 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, opts)

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

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.TagApiControllerApi();
let appIds = "appIds_example"; // String | appIds
let opts = { 
  'from': 789, // Number | from
  'to': 789, // Number | to
  'metrics': true, // Boolean | metrics
  'logs': true, // Boolean | logs
  'events': false, // Boolean | events
  'rum': true // Boolean | rum
};
apiInstance.getTagNamesUsingGET(appIds, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
appIds String appIds
from Number from [optional]
to Number 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, opts)

Gets tag names grouped by application id.

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.TagApiControllerApi();
let appIds = "appIds_example"; // String | appIds
let tag = ["tag_example"]; // [String] | tag
let opts = { 
  'from': 789, // Number | from
  'to': 789, // Number | to
  'metrics': true, // Boolean | metrics
  'logs': true, // Boolean | logs
  'events': false, // Boolean | events
  'rum': true // Boolean | rum
};
apiInstance.getTagsGroupedByIdUsingGET1(appIds, tag, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
appIds String appIds
tag [String] tag
from Number from [optional]
to Number 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

{'String': Dimension} getUsingGET(appIds, tag, opts)

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

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.TagApiControllerApi();
let appIds = "appIds_example"; // String | appIds
let tag = ["tag_example"]; // [String] | tag
let opts = { 
  'from': 789, // Number | from
  'to': 789, // Number | to
  'metrics': true, // Boolean | metrics
  'logs': true, // Boolean | logs
  'events': false, // Boolean | events
  'rum': true // Boolean | rum
};
apiInstance.getUsingGET(appIds, tag, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
appIds String appIds
tag [String] tag
from Number from [optional]
to Number 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

{'String': Dimension}

Authorization

api_key

HTTP request headers

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

getUsingGET3

{'String': Dimension} getUsingGET3(appIds, tag, opts)

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

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.TagApiControllerApi();
let appIds = "appIds_example"; // String | appIds
let tag = ["tag_example"]; // [String] | tag
let opts = { 
  'from': 789, // Number | from
  'to': 789, // Number | to
  'metrics': true, // Boolean | metrics
  'logs': true, // Boolean | logs
  'events': false, // Boolean | events
  'rum': true // Boolean | rum
};
apiInstance.getUsingGET3(appIds, tag, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
appIds String appIds
tag [String] tag
from Number from [optional]
to Number 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

{'String': Dimension}

Authorization

api_key

HTTP request headers

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