Metrics tab explained
This section is dedicated to provide you with a comprehensive understanding of the Metrics Tab within the customer portal. In this section, we will delve into the various metric parameters, offering detailed explanations and corresponding descriptions to better understand your historical usage.
What is Usage Metric?
Usage metric is record that we log when from our perspective usage of our products occured. We will name here few examples of the usage:
- Performing API calls, connections, subscriptions or other operations against our API
- Receiving or sending data to us in various forms (flat files, streaming, API calls)
- Having active API Keys or defined accounts
Metric parameters
Each metric can contain any amount of parameters and a single value. Parameters are used to identify where the usage occured. For example we will use parameters to separate the usage by API Key, Protocol or the Product that was accessed.
Below we will list complete list of the parameters that can occur:
| Parameter | Description |
|---|---|
| APIKey | API Key that initiated specific usage metric |
| DataCenter | Location where the usage metric was created (e.g. AWS-EU-EAST-1 etc) |
| DataSource | Identification of the specific data source which was related to usage metric (e.g. BINANCE, COINBASE, ETHEREUM-MAINNET etc.) |
| OperationName | The ID which identifies the operations within the ServiceName and ProtocolName, usually Data Type (DTO) otherwise id of the operation like method in the JSON-PRC calls. (e.g. QUOTES_SYMBOL_HISTORY, eth_call) |
| ProtocolName | The name of the protocol that was used to generate the metric (e.g. REST, WebSocket, FIX, S3) |
| ServiceName | The name of the product (e.g. MarketData) |
Grouping data
In the customer portal you can group the metrics by any parameter to inspect the usage in that dimension.
For example by selecting metric COINAPI_DATA_MSGS_SENT and grouping by ProtocolName you can inspect how much bytes we delivered to your application by every protocol in requested time period.
Metrics
| Metric | Parameters | Unit | Value Representation |
|---|---|---|---|
| COINAPI_DATA_MSGS_SENT | APIKey DataSource OperationName ProtocolName ServiceName | Entities | Amount of the data points/entities/messages sent by the API to the client. |
| COINAPI_DATA_BYTES_SENT | APIKey DataSource OperationName ProtocolName ServiceName | Bytes | Number of bytes sent by the API to the client. |
| COINAPI_DATA_MSGS_RECEIVED | APIKey DataSource OperationName ProtocolName ServiceName | Entities | Amount of the data points/entities/messages received by the API from the customer. |
| COINAPI_DATA_BYTES_RECEIVED | APIKey DataSource OperationName ProtocolName ServiceName | Bytes | Number of bytes received by the API from the customer. |
| COINAPI_CALLS_RECEIVED | APIKey DataSource OperationName ProtocolName ServiceName | Calls | Number of API calls received from client by the API. |
| COINAPI_CALLS_SENT | APIKey DataSource OperationName ProtocolName ServiceName | Calls | Number of API calls delivered from API to client. |
| COINAPI_REST_CREDITS | APIKey ServiceName | Credits | Number of credits used by the API calls. This is useful for the Market Data REST API where each API Call can be counted as more than single credit. |
| COINAPI_REST_APICALLS | APIKey ServiceName | Calls | (Deprecated) Number of REST API calls used, regardless of the credits used for each call. Please migrato the COINAPI_CALLS_SENT |
| COINAPI_APICALLS_COUNT | APIKey OperationName ProtocolName ServiceName | Calls | (Deprecated) Number of API calls used. Please migrate to the COINAPI_CALLS_SENT |
| COINAPI_APIKEY_DAYS | APIKey | API Key Days | Couting the number of the API Keys for the customer. We will report for each API Key active single unit for each day. |
| COINAPI_NAAS_UNITS | APIKey DataSource OperationName ProtocolName ServiceName | Credits | Number of credits used by the Node As A Service products. |
| COINAPI_JWT_VALIDATION_COUNT | APIKey | Occurences | Number of occurences where we needed to fully validate JWT Secret. |
| COINAPI_JWT_CACHE_HIT | APIKey | Occurences | Number of occurences where we do not needed to fully validate JWT Secret. |
| COINAPI_CONNECTION_SECONDS | APIKey DataSource OperationName ProtocolName ServiceName | Connection Seconds | Number of connection-seconds where the connection was established with the API. |
| COINAPI_APICALLS_RESPONSE_MILLISECONDS | APIKey DataSource OperationName ProtocolName ServiceName | Milliseconds | Number of milliseconds that we spent generating the response to the API call for the customer. |
| EMSX_EXCHANGE_RUNTIME_SECONDS | APIKey DataSource OperationName ProtocolName ServiceName | Account Seconds | Number of account-seconds counted from the accounts managed by the EMS API. |
| *_USD | Same as for the source metric | USD Cents | Metrics that we are using to convert overage or paying metrics to the USD value that will be added to the next invoice. For example the COINAPI_DATA_BYTES_SENT metric can generate USD overages by posting to the COINAPI_DATA_BYTES_SENT_USD metric. |
By understanding the Metrics Tab and its parameters, you can make informed decisions to utilize your usage better.