UBuberall
Dashboard

Get insight metrics

Changed on

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

Request

  • Base URL
    https://uberall.com/api
  • Auth
    none declared

Query parameters

vunknown
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.

metricsunknown
typeunknown
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

textFilterunknown

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.

locationIdsunknown

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

businessIdsunknown

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

labelsunknown

Label names (used when filterCategory=labels)

locationGroupIdsunknown

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

excludedLocationIdsunknown

Comma-separated location IDs to exclude from results

excludedBusinessIdsunknown

Comma-separated business IDs to exclude from results

excludedLabelsunknown

Label names to exclude from results

excludedLocationGroupIdsunknown

Location group IDs to exclude from results

Response

Insight metrics grouped by period and metric type

statusstring required

Response status

Example response

{
  "status": "SUCCESS",
  "response": {
    "metrics": [
      {
        "name": "QUERIES_DIRECT",
        "data": [
          {
            "period": "2025-01-01",
            "count": 42
          }
        ]
      }
    ]
  }
}

Changes

  • 172d9d1af202Revision changes
    • breaking

      the ///// response's property format changed from int32 to no format for status

    • warning

      added the new HOUR enum value to the / response property for the response status