---
id: telemetry-metric-read
title: Read metric data
description: Retrieve metric data points.
sidebar_label: Read metric data
hide_title: true
hide_table_of_contents: true
api: >-
  eJztWG1v2zYQ/ivEfdoA2Zadtii0T0HaDRm2NUhcrJhrBLR0ttlIJEtSbgxD/704SdaLLTuuk37bp0QmeffcPcd74QYitKER2gklIYBbdEbgCllC/4Qs4o4zrYR0tg8eKI2G09brCAJwGCPtWwfF7sAgj8ADxxcWggn8nf9qYeqB5oYn6NDQwgYE6dLcLcEDyROEALjWsQi3wj2w4RITDsEG3FrTBiEdLtBA5oHBr6kwGEHgTIrejg3jJbKGNHb9jqDjI090jBAMM68TQGHDP/TRod06I+TiaeWFzYxktrTC0jndNzqBSv3XFM261m9DpfFePM/2OxJy2OJdlWhWIjyktMvkOY/tvtJCzK5asKuwNzxsr+PG3Ttxur87lV/ffei9feMP2cfxVZ+9wzlPY2eZU8xgiNIxw+UCmZgzqRzTRq1EhFEb6MgfjXrDUW/0Zjz0g5EfXPj/HcSNMvqZqKX6djrY0VNgEyFTh/bkmOoE+2GFxogILas5Y1xGLLVo2dYfrMdKbe3gG/mHwGk0Qp0e753YbnIZTEhmMVQyOln5wqhU38/Wz6LxSiUJ71mk9OYwYpFIUFpKOqSljQWuVITetbSOyxDtQcoqGZ2snQ3tAdfBiscpMs2F2YFWoQpEbzi6eOVdxtwkd4671AY21Wh6nH7B6CBspVG+tDt3MP/GEv4okjRhQ99noUpmQuYp/uWtiVDHap2gdM9j4aa4wqZnNYZiThW1ksyEDOM0j5a5iB2athX1RkqiUw8shqkRbp1X0Blyg+YydUsIJlNaNmi1khYt4Rz5Pv3prE1U0+uSHirpUDra3Siagy+Wjmz2TVezLxg68EAb6gacKBQ2zlI56bzKRYXtdGOjGHQtVzm3a7FII/dC3pcp4FAisZRjG4vcGE6cC4eJfdrExsXs2MujSJD1PL5pndqBm3lA/j8fBbnBOp7oTl/kt6WxItNkRuZnHjjh4rrPeccdv6EggKx78Q4NaTywelsGW07ONmT3o2BYk143QG22u4tvk/LuitfJ+3DkN4ie7HKWd0cQwMc78PJ0TMIfH8GrUwbFTJ40wING2iAn7ySOksdJi5ISq9/z346Hw+D1KPD9vu/neEtu8m7syJGL/SOjbJpNs5yKV58+7V/sq1hQPkFjlGFVHmBRitRRCLnisaAaqVPHlGGJsFbIBaub8mclgjoFTiBBa/kC85a/Fbbbhc7bTbjPvxGi5O6G2vku+Yd1Z63wruaZ9zmgOrQLCwqvlTG0qa9aJb5o4ZmwrHJJVqp43UUb9c1o9mgTMsqdLxeMSyasTZEpydwS2eXNNbMiwv/5epqvMuz/UovflUm4O8AZTYuxWmybbVPQp5XJCYjVggjJnf/NKLlg80JY5YXJrkEwKBPQYDiIuMNyVqg1Jql1LOEuXJbC2GfKJdijnZ8BiqueW5qgWyoatReY+7FU0OR70xqcs0GRbwebepzNKOPmoVbkxNTEZTq2wWDAtejLNI51zB3B6YcqabUbdxRIhUubTUfFDQna9kj0XWwCr/xn63z4899xXoeEnKucCzS2uAfDvt/3oeZ1vOU1r+7KuoTnIV32ZrfIo+b7BOw0XZv6ajz1nlGa4PDRDXTMhSSNuX82pbMnzcsFHgS77xRlffMgaDwgTD1YKuvo+GYz4xY/mjjL6OeizyxKk+Wz+FDn2DTil9vyxv7KmvN9J/gHXLffEsqQh7zVPV1ne6Y/pqr5hnCmsvNn+GPAmu8LLw7swJh+BE/j3eBMNOfM4UcA1W8DZ+LpnL2PKKzm/TP1nTBtH9HeGPhfSH/HSH1Ef2uu/zkIjg/IR7DVw/u5ofCjc+4xR7Vm7xrQlD6MIETnJ9Dux+FONNvuRrb8skXZrgM/5q0Gnp334jOANMpONs08WCKPsGhMig2XYYjaNY7utYvk2qrV+OP9mMbZdpHfKerF2NMFa7MpdozVA8osq1A6+i5am+/QDVvJ
sidebar_class_name: get api-method
info_path: docs/api/telemetry
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/telemetry-metric-read'
---
<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Read metric data"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/application/{applicationId}/metric/{metricName}"}
  context={"endpoint"}
>

</MethodEndpoint>

Retrieve metric data points.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"applicationId","schema":{"type":"integer"},"required":true,"description":"The application ID.","example":1},{"in":"path","name":"metricName","schema":{"type":"string"},"required":true,"description":"Metric name.","example":"http.rpm"},{"in":"query","name":"scope_id","schema":{"type":"integer"},"required":true,"description":"Scope ID.","example":1},{"in":"query","name":"service_id","schema":{"type":"string"},"required":false,"description":"Service ID.","example":"svc-1"},{"in":"query","name":"start_time","schema":{"type":"string"},"required":false,"description":"ISO-8601 UTC. Defaults to recent range if not provided.","example":"2022-12-26T10:20:30Z"},{"in":"query","name":"end_time","schema":{"type":"string"},"required":false,"description":"ISO-8601 UTC. Defaults to now if not provided.","example":"2022-12-26T12:20:30Z"},{"in":"query","name":"minutes","schema":{"type":"integer"},"required":false,"description":"Overrides start_time and uses end_time - minutes.","example":120},{"in":"query","name":"period","schema":{"type":"integer"},"required":false,"description":"Period in seconds.","example":120},{"in":"query","name":"group_by","schema":{"type":"string"},"required":false,"description":"Comma-separated dimension names.","example":"Code,Instances"},{"in":"query","name":"dimensions","schema":{"type":"string"},"required":false,"description":"Comma-separated key:value pairs.","example":"Instances:i-1234,AlarmStatus:super-alarmed"},{"in":"query","name":"open_by","schema":{"type":"string"},"required":false,"description":"Comma-separated key:value pairs; maximum 100 combinations.","example":"Instances:i-1234,AlarmStatus:super-alarmed"},{"in":"query","name":"deployments","schema":{"type":"string"},"required":false,"description":"Provider-specific deployment inclusion filter.","example":"deployment-1"}]}
>

</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>

</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Metric datapoints.","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"integer"},"metric":{"type":"string"},"start_time":{"type":"string"},"end_time":{"type":"string"},"period_in_seconds":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"dimensions":{"type":"object","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string"},"value":{"type":"number"}},"title":"metricDataPoint"}}},"title":"metricDataSeries"}}},"title":"metricDataResponse"},"example":{"application_id":1,"metric":"http.rpm","start_time":"2022-12-26T10:20:30Z","end_time":"2022-12-26T12:20:30Z","period_in_seconds":120,"results":[{"dimensions":{"Scope":"US","Code":"2xx","Instances":"i-1234","AlarmStatus":"super-alarmed"},"data":[{"timestamp":"2022-10-08T11:52:00.000Z","value":1},{"timestamp":"2022-10-08T11:53:00.000Z","value":2}]}]}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"error":{"type":"array","items":{"type":"object","properties":{"instancePath":{"type":"string"},"message":{"type":"string"}}}}},"title":"telemetryError"},"examples":{"missingScope":{"value":{"message":"scope is required"}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"error":{"type":"array","items":{"type":"object","properties":{"instancePath":{"type":"string"},"message":{"type":"string"}}}}},"title":"telemetryError"},"examples":{"invalidLogFormat":{"value":{"message":"The log provider is reporting logs in the wrong format","error":[{"instancePath":"/results/1/datetime","message":"must match format \"date-time\""}]}}}}}}}}
>

</StatusCodes>

