---
updatedAt: 2025-04-23T17:13:59.000Z
agentTools:
  projectIndex: https://wiki.manifold.autos/llms.txt
---

# Behavioral report

Provides insight into incidents within the specified time range that are grouped by their translated type.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Manifold Data REST API",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api.analytics.autos/",
      "description": "Manifold REST API Base URL"
    }
  ],
  "paths": {
    "/reports/overview/behavioral": {
      "get": {
        "tags": [
          "Report"
        ],
        "summary": "Behavioral report",
        "description": "Provides insight into incidents within the specified time range that are grouped by their translated type.",
        "parameters": [
          {
            "name": "from",
            "in": "query",
            "description": "The start date of the range to filter incidents,\r\n            as defined by RFC 3339, section 5.6, for example, 2017-07-21T00:00:00Z.\r\n            Limited to a 90-day window with respect to from and to.",
            "style": "form",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "to",
            "in": "query",
            "description": "The end date of the range to filter incidents, specified as an RFC 3339 timestamp.",
            "style": "form",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "vehicleIds",
            "in": "query",
            "description": "The optional unique identifier of the vehicle to filter incidents.",
            "style": "form",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            }
          },
          {
            "name": "vehicleGroupIds",
            "in": "query",
            "description": "The optional unique identifiers of the vehicle groups to filter incidents.",
            "style": "form",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "connectionId",
            "in": "query",
            "description": "The optional unique identifier for the connection to filter incidents.",
            "style": "form",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "incidentType",
            "in": "query",
            "description": "The optional type of incident-to-filter results.",
            "style": "form",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BehavioralReportModel"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "429": {
            "description": "Rate limited"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "BehavioralReportModel": {
        "type": "object",
        "properties": {
          "incidentRiskAndRates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IncidentRiskAndRateResponseModel"
            },
            "description": "List of incident risk and rate data for different incident types",
            "nullable": true
          },
          "speedingAnalytics": {
            "$ref": "#/components/schemas/SpeedingAnalyticsResponseModel"
          },
          "incidentAnalytics": {
            "$ref": "#/components/schemas/IncidentAnalyticsResponseModel"
          }
        },
        "additionalProperties": false,
        "description": "Model representing behavioral report data including incident risks/rates and speeding analytics"
      },
      "IncidentAnalyticsResponseModel": {
        "type": "object",
        "properties": {
          "incidentType": {
            "type": "string",
            "description": "The type/category of the incident being analyzed",
            "nullable": true
          },
          "filteredRate": {
            "type": "number",
            "description": "Rate value for filtered data",
            "format": "double"
          },
          "clientRate": {
            "type": "number",
            "description": "Rate value across all client data",
            "format": "double"
          },
          "filteredRisk": {
            "type": "number",
            "description": "Risk value for filtered data",
            "format": "double"
          },
          "clientRisk": {
            "type": "number",
            "description": "Risk value across all client data",
            "format": "double"
          },
          "filteredRiskTrendOverTime": {
            "type": "object",
            "additionalProperties": {
              "type": "number",
              "format": "double"
            },
            "description": "Historical trend of filtered risk values over time",
            "nullable": true
          },
          "clientRiskTrendOverTime": {
            "type": "object",
            "additionalProperties": {
              "type": "number",
              "format": "double"
            },
            "description": "Historical trend of client risk values over time",
            "nullable": true
          },
          "filteredRateTrendOverTime": {
            "type": "object",
            "additionalProperties": {
              "type": "number",
              "format": "double"
            },
            "description": "Historical trend of filtered rate values over time",
            "nullable": true
          },
          "clientRateTrendOverTime": {
            "type": "object",
            "additionalProperties": {
              "type": "number",
              "format": "double"
            },
            "description": "Historical trend of client rate values over time",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Model containing detailed analytics about incidents"
      },
      "IncidentRiskAndRateResponseModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type/category of the incident",
            "nullable": true
          },
          "risk": {
            "type": "number",
            "description": "The calculated risk value for this incident type",
            "format": "double"
          },
          "rate": {
            "type": "number",
            "description": "The calculated rate value for this incident type",
            "format": "double"
          }
        },
        "additionalProperties": false,
        "description": "Model representing risk and rate data for a specific incident type"
      },
      "SpeedingAnalyticsResponseModel": {
        "type": "object",
        "properties": {
          "totalSpeedingDistanceDriven": {
            "type": "number",
            "description": "Total distance driven while speeding, measured in kilometers",
            "format": "double"
          },
          "totalDistanceDriven": {
            "type": "number",
            "description": "Total distance driven regardless of speed, measured in kilometers",
            "format": "double"
          },
          "dayTimeSpeedingDistance": {
            "type": "number",
            "description": "Distance driven while speeding during daylight hours, measured in kilometers",
            "format": "double"
          },
          "clientAveragePercent": {
            "type": "number",
            "description": "Average percentage of speeding across all client data",
            "format": "double"
          },
          "filteredSpeedingDistanceTrendOverTime": {
            "type": "object",
            "additionalProperties": {
              "type": "number",
              "format": "double"
            },
            "description": "Represents a trend of speeding distance over time.\r\nThe key is the month and year (DateOnly) of the recorded data,\r\nand the value is the normalized speeding metric measured in kilometers.",
            "nullable": true
          },
          "clientSpeedingDistanceTrendOverTime": {
            "type": "object",
            "additionalProperties": {
              "type": "number",
              "format": "double"
            },
            "description": "Represents a trend of speeding distance over time.\r\nThe key is the month and year (DateOnly) of the recorded data,\r\nand the value is the normalized speeding metric measured in kilometers.\r\nthis data is for all connections",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Model containing detailed analytics about speeding behavior"
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "description": "API Key needed to access the endpoints. x-api-key: {API Key}",
        "name": "X-API-KEY",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "ApiKey": []
    }
  ],
  "x-readme": {}
}
```