Sign in
latestOpenAPI 3.0.1Licensed under Uberall2026-08-1530255414.1 MB

172d9d1af202

Dashboard

Get insight metrics

Retrieves insight metrics (Google Impressions, Clicks, Driving Directions, Facebook interactions, Bing, Yelp) for filtered locations within a date range. Metrics are grouped by time period with granularity auto-determined by the date range: daily (<=31d), weekly (<90d), monthly (<=365d), or quarterly (>365d). Defaults to the last 30 days if startDate is not provided. group=HOUR is only valid for the ACTIONS_PHONE metric and returns the whole range as a single bucket whose count is the hour-of-day profile keyed phone0..phone23.

get/dashboard/insights-data

Query parameters

{"stackTrail":"paths:/dashboard/insights-data:get:parameters:0:schema","oasType":"schema","type":"unknown","example":20260713}

API version. Defaults to the latest version. Versions older than 20260713 label each period by granularity (weekly '2025 3', monthly and quarterly 2025-3, yearly 2025) instead of returning the ISO start date of the period.

{"stackTrail":"paths:/dashboard/insights-data:get:parameters:1:schema","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/dashboard/insights-data:get:parameters:2:schema","oasType":"schema","type":"unknown"}
startDatestring
Example:2025-01-01

Start date (inclusive) as an ISO-8601 date or date-time, with or without zone/offset (e.g. 2025-01-01, 2025-01-01T14:30:00, 2025-01-01T14:30:00Z, 2025-01-01T14:30:00%2B02:00). Zone-aware values are normalised to UTC. The formats yyyy.MM.dd, dd.MM.yyyy, dd-MM-yyyy HH:mm:ss and dd.MM.yyyy HH:mm:ss are also accepted. Optional for most endpoints — defaults to a period before end date if omitted.

endDatestring
Example:2025-03-31

End date (inclusive) as an ISO-8601 date or date-time, with or without zone/offset. Zone-aware values are normalised to UTC. The formats yyyy.MM.dd, dd.MM.yyyy, dd-MM-yyyy HH:mm:ss and dd.MM.yyyy HH:mm:ss are also accepted. Defaults to today.

group'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR'
Example:MONTHLY

Overrides the automatic granularity of the date range. Case-insensitive. When omitted, granularity is derived from the range length. Legacy values DAY, WEEK, MONTH and YEAR are also accepted. HOUR returns the whole range as a single bucket holding the ACTIONS_PHONE hour-of-day profile (phone0..phone23) and is only valid for the ACTIONS_PHONE metric; other endpoints treat it as DAILY.

filterCategory'location' | 'business' | 'labels' | 'location-groups'

Filter strategy to use for scoping locations

{"stackTrail":"paths:/dashboard/insights-data:get:parameters:7:schema","oasType":"schema","type":"unknown"}

Deprecated: use the newer query parameter instead. Free-text location search that narrows results to matching locations (matches name, address, identifier and label fields). Supports #label and @group tokens (e.g. "main st #premium @north"), combined with AND semantics. Applied only when no filterCategory is set.

{"stackTrail":"paths:/dashboard/insights-data:get:parameters:8:schema","oasType":"schema","type":"unknown"}

Comma-separated location IDs (used when filterCategory=location)

{"stackTrail":"paths:/dashboard/insights-data:get:parameters:9:schema","oasType":"schema","type":"unknown"}

Comma-separated business IDs (used when filterCategory=business)

{"stackTrail":"paths:/dashboard/insights-data:get:parameters:10:schema","oasType":"schema","type":"unknown"}

Label names (used when filterCategory=labels)

{"stackTrail":"paths:/dashboard/insights-data:get:parameters:11:schema","oasType":"schema","type":"unknown"}

Location group IDs (used when filterCategory=location-groups)

{"stackTrail":"paths:/dashboard/insights-data:get:parameters:12:schema","oasType":"schema","type":"unknown"}

Comma-separated location IDs to exclude from results

{"stackTrail":"paths:/dashboard/insights-data:get:parameters:13:schema","oasType":"schema","type":"unknown"}

Comma-separated business IDs to exclude from results

{"stackTrail":"paths:/dashboard/insights-data:get:parameters:14:schema","oasType":"schema","type":"unknown"}

Label names to exclude from results

{"stackTrail":"paths:/dashboard/insights-data:get:parameters:15:schema","oasType":"schema","type":"unknown"}

Location group IDs to exclude from results

Response

Insight metrics grouped by period and metric type