changedInput schema / properties / from_year / description
Previous value: -"Start year of the data range (inclusive). The API uses monthly granularity."New value: +"Start year of the data range (inclusive), 1985 through the current year. The API uses monthly granularity."
changedInput schema / properties / from_year / maximum
Previous value: -2030New value: +9007199254740991
changedInput schema / properties / from_year / minimum
Previous value: -2000New value: +1985
addedInput schema / properties / include_comparisons
Added value: +{
+ "default": false,
+ "description": "Also return the comparison entities CDE sends with state or agency data (an agency's state and the United States, or a state's United States) as monthly rates, populations and coverage for the scoped months. Must be false or omitted for national scope.",
+ "type": "boolean"
+}
changedInput schema / properties / ori / description
Previous value: -"Nine ASCII-letter/digit ORI code (e.g. CA0010400, DCMPD0000); case-insensitive. Only permitted and required for agency scope."New value: +"Nine ASCII-letter/digit ORI code (e.g. CA0010400, DCMPD0000); case-insensitive. Find an agency's ORI with fbi_search_agencies. Only permitted and required for agency scope."
changedInput schema / properties / to_year / description
Previous value: -"End year of the data range (inclusive)."New value: +"End year of the data range (inclusive), 1985 through the current year."
changedInput schema / properties / to_year / maximum
Previous value: -2030New value: +9007199254740991
changedInput schema / properties / to_year / minimum
Previous value: -2000New value: +1985
addedOutput schema / properties / comparisons
Added value: +{
+ "description": "Present only when include_comparisons is true: the comparison entities in CDE's order (an agency's state, then the United States; a state's United States). Empty when CDE sent none. CDE sends no counts for comparison entities.",
+ "items": {
+ "additionalProperties": false,
+ "description": "Rates, populations and coverage CDE sent for one comparison entity.",
+ "properties": {
+ "entity_name": {
+ "description": "Comparison entity name as CDE labels it.",
+ "type": "string"
+ },
+ "months": {
+ "description": "One row per scoped month, in the same order as months.",
+ "items": {
+ "additionalProperties": false,
+ "description": "One month of comparison rates, matching a scoped month.",
+ "properties": {
+ "clearance_rate_per_100k": {
+ "description": "Comparison entity clearance rate per 100,000 participating population; null when unavailable.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "month": {
+ "description": "Month (1–12).",
+ "type": "number"
+ },
+ "participated_population": {
+ "description": "Provider participating population for the comparison entity and month; null when unavailable.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "population": {
+ "description": "Provider population for the comparison entity and month; null when unavailable.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "population_coverage_percent": {
+ "description": "Provider reporting coverage percentage for the comparison entity and month; never calculated, null when unavailable.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "rate_per_100k": {
+ "description": "Comparison entity offense rate per 100,000 participating population; null when unavailable.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "year": {
+ "description": "Year.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "year",
+ "month",
+ "rate_per_100k",
+ "clearance_rate_per_100k",
+ "population",
+ "participated_population",
+ "population_coverage_percent"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "entity_name",
+ "months"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `invalid_date_range`: The complete starting year/month is later than the ending year/month. `scope_param_incompatible`: Identifiers are supplied for a scope that does not apply them. `scope_param_missing`: scope is \"state\" but state_abbr is missing, or scope is \"agency\" but ori is missing. `no_data`: No data was returned for the requested offense and date range. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `invalid_date_range`: The complete starting year/month is later than the ending year/month. `scope_param_incompatible`: Identifiers are supplied for a scope that does not apply them, or include_comparisons is true for national scope. `scope_param_missing`: scope is \"state\" but state_abbr is missing, or scope is \"agency\" but ori is missing. `year_out_of_range`: from_year or to_year is after the current UTC year. `no_data`: No data was returned for the requested offense and date range. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "invalid_date_range",
- "scope_param_incompatible",
- "scope_param_missing",
- "no_data"
-]New value: +[
+ "invalid_date_range",
+ "scope_param_incompatible",
+ "scope_param_missing",
+ "year_out_of_range",
+ "no_data"
+]
changedOutput schema / properties / months / items / properties / clearance_rate_per_100k / description
Previous value: -"Clearance rate per 100,000 population."New value: +"Clearance rate per 100,000 participating population."
changedOutput schema / properties / months / items / properties / rate_per_100k / description
Previous value: -"Offense rate per 100,000 population."New value: +"Offense rate per 100,000 participating population."