---
updatedAt: 2026-06-12T11:16:53.000Z
agentTools:
  projectIndex: https://apidocs.neuronsinc.com/llms.txt
---

# Get Usage Metrics

# Get usage metrics
Returns the processed images and videos for a specified period.
- **start** the start date in DD-MM-YYYY format(mandatory)
- **end** the end date in DD-MM-YYYY format(optional)

If _end_ date is not provided then the usage count is up to the current date

FIlter parameters:

* **start** the start date in DD-MM-YYYY format(mandatory)
* **end** the end date in DD-MM-YYYY format(optional)

**NOTE:** If *end* date is not provided then the usage count is up to the current date

### Example of a successful response

This endpoint returns a basic count of uploaded media, which looks like below:

```json
{
  "image_count": 29,
  "video_count": 7
}
```

**NOTE:** The dates provided are pointing to 00:00 UTC time. So, if querying for dates between **01-02-2026** and **09-02-2026**, the filter will query media created between **midnight** of the **1st of February** and **midnight** on the **9th of February**, hence all assets created on the 1st of February would be accounted for but only assets created until 23:59 of the 8th of February would be counted.  To count assets predicted during the 9th of February, then the provided end date should have one additional day added to the desired date (so it would be **10-02-2026**).

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Neurons Customers API v2",
    "version": "2.0.0",
    "description": "Neurons Customers API"
  },
  "paths": {
    "/predict/v2/account/usage": {
      "get": {
        "operationId": "getUsageMetrics",
        "summary": "Get Usage Metrics",
        "parameters": [
          {
            "in": "query",
            "name": "start",
            "schema": {
              "description": "The start date in format 'DD-MM-YYYY'",
              "title": "Start",
              "type": "string"
            },
            "required": true,
            "description": "The start date in format 'DD-MM-YYYY'"
          },
          {
            "in": "query",
            "name": "end",
            "schema": {
              "description": "The end date in format 'DD-MM-YYYY'",
              "title": "End",
              "type": "string"
            },
            "required": false,
            "description": "The end date in format 'DD-MM-YYYY'"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageMetrics"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          },
          "412": {
            "description": "Precondition Failed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Content",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Detail"
                }
              }
            }
          }
        },
        "description": "# Get usage metrics\nReturns the processed images and videos for a specified period.\n- **start** the start date in DD-MM-YYYY format(mandatory)\n- **end** the end date in DD-MM-YYYY format(optional)\n\nIf _end_ date is not provided then the usage count is up to the current date",
        "tags": [
          "Account"
        ],
        "security": [
          {
            "LegacyPredictAPIAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Detail": {
        "properties": {
          "detail": {
            "title": "Detail",
            "type": "string"
          }
        },
        "required": [
          "detail"
        ],
        "title": "Detail",
        "type": "object"
      },
      "UsageMetrics": {
        "properties": {
          "image_count": {
            "title": "Image Count",
            "type": "integer"
          },
          "video_count": {
            "title": "Video Count",
            "type": "integer"
          }
        },
        "required": [
          "image_count",
          "video_count"
        ],
        "title": "UsageMetrics",
        "type": "object"
      }
    },
    "securitySchemes": {
      "LegacyPredictAPIAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.neuronsinc.com"
    }
  ]
}
```