Source Volume - Teradata Listener

Teradata® Listener™ User Guide

Product
Teradata Listener
Release Number
2.05
Published
March 2019
Language
English (United States)
Last Update
2019-04-25
dita:mapPath
vlj1546974296436.ditamap
dita:ditavalPath
ft:empty
dita:id
B035-2910
lifecycle
previous
Product Category
Analytical Ecosystem

Volume for all data flowing into Ingest for a single source during a given time frame.

Definition

GET https://CLUSTER.DOMAIN/listener/appservices/sources/{source_id}/volume?interval,timeframe HTTP/1.1
Parameter Required Type Sample Purpose
source_id Required string 758fbda4-accc-4f90-8f09-cc0a164c8c28 Source ID associated with this target.
interval Optional string 1m Time interval for each data point.
timeframe Optional string 7d Time frame to query into the past.
Parameters use an integer and character combination to denote the time range:
  • s = seconds
  • m = minutes
  • h = hours
  • d = days
  • w = weeks
  • M = months

Example Request

curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer TOKEN" \
  -X GET \
  -i \
  https://CLUSTER.DOMAIN/listener/appservices/sources/758fbda4-accc-4f90-8f09-cc0a164c8c28/volume

Example Response

HTTP/1.1 200 OK
Content-Type: application/json
[{
	"avg_bytes": {
		"value": 273276.63157894736
	},
	"doc_count": 128000,
	"ingested_records": {
		"value": 128000
	},
	"time": "2017-11-17T20:00:00Z",
	"total_bytes": {
		"value": 41538048
	},
	"total_docs": {
		"value": 152
	}
}]

Response Codes

Code Description
200 Metrics successfully loaded.
401 Authorization header not found.
404 Resource not found.