Returns a list of custom metrics for the source

curl --request GET \
  --url http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "content": [
    {
      "expression": "SUM(sales_in_usd) + SUM(sales_in_uah) * uah_to_usd_exchange_rate",
      "name": "sum_of_sales",
      "label": "Sum of Sales",
      "visible": true,
      "numberFormat": {
        "type": "PLAIN",
        "decimals": 2,
        "separator": true,
        "negative": "SIGNED",
        "standardUnit": "NONE",
        "storageUnit": "BYTES",
        "currencyCode": "USD"
      },
      "timeFormat": {
        "timeZone": "UTC",
        "options": {
          "second": "NUMERIC",
          "minute": "NUMERIC",
          "hour": "NUMERIC",
          "day": "NUMERIC",
          "weekday": "LONG",
          "week": "TWO_DIGIT",
          "month": "NUMERIC",
          "quarter": "TWO_DIGIT",
          "year": "NUMERIC",
          "dayOfYear": "NUMERIC",
          "hour12": true
        }
      },
      "granularity": "MILLISECOND",
      "dataType": "ATTRIBUTE"
    }
  ],
  "pageInfo": {
    "nextPageToken": "<string>",
    "previousPageToken": "<string>"
  }
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "path": "<string>"
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

Returns a list of custom metrics for the source

curl --request GET \
  --url http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/sources/{sourceId}/custom-metrics")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "content": [
    {
      "expression": "SUM(sales_in_usd) + SUM(sales_in_uah) * uah_to_usd_exchange_rate",
      "name": "sum_of_sales",
      "label": "Sum of Sales",
      "visible": true,
      "numberFormat": {
        "type": "PLAIN",
        "decimals": 2,
        "separator": true,
        "negative": "SIGNED",
        "standardUnit": "NONE",
        "storageUnit": "BYTES",
        "currencyCode": "USD"
      },
      "timeFormat": {
        "timeZone": "UTC",
        "options": {
          "second": "NUMERIC",
          "minute": "NUMERIC",
          "hour": "NUMERIC",
          "day": "NUMERIC",
          "weekday": "LONG",
          "week": "TWO_DIGIT",
          "month": "NUMERIC",
          "quarter": "TWO_DIGIT",
          "year": "NUMERIC",
          "dayOfYear": "NUMERIC",
          "hour12": true
        }
      },
      "granularity": "MILLISECOND",
      "dataType": "ATTRIBUTE"
    }
  ],
  "pageInfo": {
    "nextPageToken": "<string>",
    "previousPageToken": "<string>"
  }
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "path": "<string>"
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Path Parameters

sourceId

string

required

Query Parameters

maxResults

integer<int32>

default:0

Required range: x >= 0

pageToken

string

Response

Custom metrics were retrieved successfully

content

object[]

Show child attributes

pageInfo

object

Show child attributes

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Returns a list of custom metrics for the source

Authorizations

Path Parameters

Query Parameters

Response