Phrases API - Impacts
ImpactsThe Impacts endpoint provides a detailed description of all immediate and short-term weather risks and alerts for an activity at a particular location. Currently, this supports the activities: general (i.e. outdoor activities - which covers the widest range of use cases), roadway_trucking, maritime_large_vessel, and maritime_small_craft
This endpoint utilizes the weather variables from the classic Impacts endpoint to evaluate the level of risk they pose for the given activity, allowing for more accurate planning and informed decision making about when to engage in the activity. The alerts, if any, will always be present in the output regardless of the minimum severity selected. For more information about the types of base risks available, please refer to the linked classic Impacts endpoint.
Note: The impacts activities offered by this endpoint may not directly use the same activity name values offered in the classic endpoint.
Requests
Every request to the endpoint must include one of the supported actions in the url.
https://phrases.api.xweather.com/impacts/:activity/{action}?client_id={client_id}&client_secret={client_secret}&{params}Supported Parameters
The following parameters are optional unless otherwise noted:
| Parameter | Description | Format |
|---|---|---|
| stream | Type: stringWhether to stream the results in real-time. The default value is false. | stream=:boolean |
| units | Type: stringThe units to use for the results. The default value is both. Valid values are: both, imperial, metric. | units=:string |
| personality | Type: stringThe personality to use for the results. The default value is default, which is a helpful meteorologist. Valid values are: default, meteorologist, on_air_met, radio_host, shock_jock. | personality=:string |
| language | Type: stringThe desired output language of the results. The default value is en. Refer to the list of Supported Languages for the full range of values. | language=:string |
| tz | Type: stringThe caller's full IANA time zone, such as Europe/Helsinki or America/Chicago. Relative dates such as tomorrow and dates/times without a UTC offset are interpreted in this time zone. When omitted, the requested location's time zone is used. | tz=:string |
| tz_display | Type: stringThe time zones to use for times in the response. The default value is both. Valid values are: location for the requested location's time zone, caller for the caller's tz, or both for both time zones. When tz is omitted, times use the requested location's time zone for all options. Time zone references are combined when both zones share the same UTC offset throughout the requested period. | tz_display=:string |
| min_severity | Type: stringThe minimum severity level of impacts to return. The default value is 1". Valid values are:0-5. | min_severity=:string |
| include_location | Type: stringWhether to include a reference to the requested location in the response. The default value is true. | include_location=:boolean |
Response
The following is an example of what each object in the response will consist of. Depending on your requested action, the response may contain multiple instances of this object within an array.
Properties
response (string)
The object containing the text summary output.
{
"response": "The current weather conditions in Wayzata, MN, present significant risks for outdoor activities due to feels-like temperatures of -20.5°C (-4°F). These extreme cold conditions can lead to frostbite and hypothermia in a short amount of time, making prolonged outdoor exposure dangerous. It is advisable to limit outdoor activities and ensure proper clothing and precautions if venturing outside."
}