Retrieve detailed accuracy metrics for events recorded in the connected account. This report provides insights into how well events are detected, categorized by incident type and evaluated across different intensity levels. The data includes accuracy metrics both from the telematics service provider (TSP) and Manifold's AI validation..

Retrieve Event Accuracy Statistics

Endpoint:

GET /reports/event-accuracy

Description:

Retrieve accuracy statistics for detected events within a specified time range. The endpoint calculates metrics such as the percentage of accurate and inaccurate events offering valuable insights into system performance.

Query Parameters:

Parameter	Type	Description
`connectionId`	`string`	The unique ID of the connection for which the report is generated. If not provided, data across all connections is included.
`providerId`	`string`	The unique ID of the provider. Use this to filter data specific to a telematics provider.
`from`	`date-time`	Start date for the report in ISO 8601 format (e.g., `2024-01-01T00:00:00Z`). Default: None (includes all historical data).
`to`	`date-time`	End date for the report in ISO 8601 format (e.g., `2024-01-07T23:59:59Z`). Default: None (includes data up to the current date).

Headers:

Header	Type	Description
`x-api-key`	String	Required for API authentication.
`Connection-Id`	UUID	Identifies the specific connection.

Example Request (cURL):

curl --request GET \
  --url "https://api.analytics.autos/reports/event-accuracy?from=2024-10-01&to=2024-10-12&eventTypes=Crash" \
  --header 'x-api-key: YOUR-API-KEY' \
  --header 'Connection-Id: YOUR-CONNECTION-ID'

Response:

```
{
  "status": 200,
  "message": null,
  "data": [
    {
      "incidentType": "Tailgating",
      "accuracy": {
        "tsp": {
          "accurateCount": 3,
          "inaccurateCount": 0
        },
        "manifold": 2
      },
      "intensity": {
        "veryLow": 0,
        "low": 0,
        "medium": 3,
        "high": 2,
        "critical": 0
      }
    },
    {
      "incidentType": "Hard Cornering",
      "accuracy": {
        "tsp": {
          "accurateCount": 5,
          "inaccurateCount": 2
        },
        "manifold": 0
      },
      "intensity": {
        "veryLow": 4,
        "low": 3,
        "medium": 0,
        "high": 0,
        "critical": 0
      }
    },
    {
      "incidentType": "Near Collision",
      "accuracy": {
        "tsp": {
          "accurateCount": 0,
          "inaccurateCount": 0
        },
        "manifold": 3
      },
      "intensity": {
        "veryLow": 0,
        "low": 0,
        "medium": 1,
        "high": 2,
        "critical": 0
      }
    },
    {
      "incidentType": "Hard Brake",
      "accuracy": {
        "tsp": {
          "accurateCount": 48,
          "inaccurateCount": 3
        },
        "manifold": 2
      },
      "intensity": {
        "veryLow": 7,
        "low": 24,
        "medium": 18,
        "high": 4,
        "critical": 0
      }
    },
    {
      "incidentType": "Stop Sign Pass",
      "accuracy": {
        "tsp": {
          "accurateCount": 62,
          "inaccurateCount": 4
        },
        "manifold": 0
      },
      "intensity": {
        "veryLow": 34,
        "low": 30,
        "medium": 2,
        "high": 0,
        "critical": 0
      }
    },
    {
      "incidentType": "Accident",
      "accuracy": {
        "tsp": {
          "accurateCount": 2,
          "inaccurateCount": 0
        },
        "manifold": 0
      },
      "intensity": {
        "veryLow": 0,
        "low": 0,
        "medium": 0,
        "high": 0,
        "critical": 2
      }
    },
    {
      "incidentType": "Late Braking",
      "accuracy": {
        "tsp": {
          "accurateCount": 1,
          "inaccurateCount": 0
        },
        "manifold": 2
      },
      "intensity": {
        "veryLow": 0,
        "low": 1,
        "medium": 1,
        "high": 1,
        "critical": 0
      }
    },
    {
      "incidentType": "Distracted Driving",
      "accuracy": {
        "tsp": {
          "accurateCount": 2689,
          "inaccurateCount": 26
        },
        "manifold": 5
      },
      "intensity": {
        "veryLow": 11,
        "low": 158,
        "medium": 1842,
        "high": 709,
        "critical": 0
      }
    },
    {
      "incidentType": "Seatbelt",
      "accuracy": {
        "tsp": {
          "accurateCount": 0,
          "inaccurateCount": 0
        },
        "manifold": 11
      },
      "intensity": {
        "veryLow": 0,
        "low": 1,
        "medium": 3,
        "high": 7,
        "critical": 0
      }
    }
  ],
  "next": null
}
```

Response Fields Explained:

incidentType: Type of incident detected (e.g., "Tailgating", "Hard Cornering", "Distracted Driving"). Represents the category of the event.
accuracy: Object containing event accuracy statistics:
- tsp: Accuracy data reported by the Telematics Service Provider (TSP).
  - accurateCount: Number of events correctly detected by the TSP.
  - inaccurateCount: Number of events incorrectly detected by the TSP.
- manifold: Number of additional validated events by Manifold. This represents the events detected and validated by Manifold’s systems.
intensity: Object representing the intensity breakdown for the specific event type:
- veryLow: Number of events categorized as having very low intensity.
- low: Number of events categorized as having low intensity.
- medium: Number of events categorized as having medium intensity.
- high: Number of events categorized as having high intensity.
- critical: Number of events categorized as having critical intensity.

Incidents

Description

Retrieve a normalized report of incident counts per type. The data is calculated per 1000 kilometers, providing insights into the frequency of various events relative to the distance traveled.

HTTP Request

GET /reports/incident

Query Parameters

Parameter	Type	Description
`connectionId`	`string`	The unique ID of the connection for which the report is generated.
`from`	`date-time`	Start date for the report in ISO 8601 format (e.g., `2024-01-01T00:00:00Z`). Default: None (includes all historical data).
`to`	`date-time`	End date for the report in ISO 8601 format (e.g., `2024-01-07T23:59:59Z`). Default: None (includes data up to the current date).

Example Response:

[
  {
    "type": "Harsh Braking",
    "count": 12.5
  },
  {
    "type": "Speeding",
    "count": 8.3
  }
]

Response Fields Explained:

type (string): Human-readable name of the incident type (e.g., Harsh Braking, Speeding).
count (number): Normalized count of incidents per 1000 kilometers.

Global Report

Description

Retrieve a global report summarizing metrics across all clients in the system. This endpoint aggregates data, such as average normalized incident counts per type, offering a high-level overview of performance and risk patterns.

HTTP Request

GET /reports/global

Example Response:

{
  "normalizedAccurateIncidentAveragePerType": [
    {
      "type": "Harsh Braking",
      "count": 10.2
    },
    {
      "type": "Speeding",
      "count": 5.8
    }
  ]
}

Response Fields Explained: ****

normalizedAccurateIncidentAveragePerType: An array of objects, each representing:
- type (string): Human-readable name of the incident type (e.g., Harsh Braking, Speeding).
- count (number): The average normalized count of incidents per 1000 kilometers across all clients.