--- title: "Get the metrics defined for a set of securities" method: GET path: "/security/{type}/metrics" tags: ["security"] --- # Get the metrics defined for a set of securities `GET /security/{type}/metrics` ## Request - Base URL: `https://api.merqube.com` - URL: `https://api.merqube.com/security/{type}/metrics` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) Get the metrics defined for a set of securities, however this only currently supports getting exactly one by name - more to come. That is, this allows you to query the metric definitions of a security by name rather than by id. ## Path parameters - `type` string, required ## Query parameters - `name` string - `prefer_read_replica` boolean ## Response `200` 200 response - MetricsSchema[] - `data_type` 'string' | 'number64' | 'datetime64' | 'int64' | 'bool' | 'object', required - `description` string, required: a description of what this metric represents - `name` string, required: metric name - `object_schema` object: optional - this supports complex objects, ie you can specify the metric is of this schema. THis allows you to upload a json schema itself of this metric. THis is for downstream users of this metric. --- [API](https://skmtc.dev/merqube/apis/merqube-api.md) - [All operations](https://skmtc.dev/merqube/apis/merqube-api/llms.txt) - [OpenAPI document](https://skmtc.dev/merqube/apis/merqube-api/revisions/20f47ca36587?raw)