Environment

Event statistics

Aggregated event statistics. Shows total counts, duration, and breakdowns by flag state and gear type for a given event type and date range.

get/api/v1/gfw/events/stats

Query parameters

typestring

Event type: fishing, encounter, loitering, port_visit.

start_datestring

Start date (YYYY-MM-DD). Default: 90 days ago.

end_datestring

End date (YYYY-MM-DD). Default: today.

Response

Aggregated event statistics broken down by flag state and gear type.

Example response

{
  "meta": {
    "endpoint": "/api/v1/fred/us/cpi",
    "data_time": "2026-04-16T14:30:00Z",
    "response_time": "2026-04-16T14:30:12Z",
    "provider": "Sugra API v1.0.1",
    "data_age_days": 8.532,
    "source": "sugra_crypto",
    "attribution": "Short interest and Reg SHO daily short volume data is owned by and sourced from FINRA (Financial Industry Regulatory Authority).",
    "fallback_chain": [
      "sugra_crypto",
      "sugra_finance"
    ],
    "period": "2026-Q1",
    "notes": "the UKMTO report behind these counts is dated 2026-08-21 and is 11 days old"
  }
}

Changes

Changed in 3 of the 22 revisions of this API.1317

Sep 1, 2026328d061c12ca3See the full diff
- ○
  added the optional property meta/data_age_days to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meta/notes to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property meta/period to the response with the 200 status
  response-optional-property-added
Aug 28, 2026560e8847c7b3132See the full diff
- ▲
  the response property data/date_range became optional for the status 200
  response-property-became-optional
- ▲
  the response property data/event_type became optional for the status 200
  response-property-became-optional
- ▲
  the response property data/stats became optional for the status 200
  response-property-became-optional
- ▲
  response property data/event_type list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the data/date_range response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the data/stats response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property data/date_range/end from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/date_range/start from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/stats/flags from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/stats/numEvents from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/stats/numFlags from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/stats/numVessels from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/stats/timeseries from the response with the 200 status
  response-required-property-removed
- ○
  added DateRange subschema #2 to the data/date_range response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added GfwStats subschema #2 to the data/stats response property anyOf list for the response status 200
  response-property-any-of-added
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 8, 20264c4530760ba112See the full diff
- ○
  added the optional property code to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property hint to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property hint to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property hint to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property plan to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property plan to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property plan to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property reason to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property reason to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property reason to the response with the 503 status
  response-optional-property-added

Full history