Skip to content
API Reference
/
Data Points
/
Get Data Points' Statistics

Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

Languages
Servers
Mock server

https://docs.uberall.com/_mock/apis/swagger/

https://uberall.com/api/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Points

Products - Data Points

Operations

Reply to a Data Point

Request

Reply with a text to a Data Point, e.g. a review

Security
accessToken or privateKey
Path
idstringrequired

The uberall unique ID of the data point you want to reply to

Query
replystringrequired

The text you want to reply, on most directories this will be published and can be read by the author of the original data point

curl -i -X PATCH \
  'https://docs.uberall.com/_mock/apis/swagger/data-points/{id}/reply?reply=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Reply sent

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​dataPointobject

Data Point Model

Response
No content

Get Data Points' Statistics

Request

Returns statistics about the locations inbox.

Security
accessToken or privateKey
Query
businessIdsArray of strings

Ids of businesses you want inbox statistics for

countriesArray of strings

The countries you want data points' statistics for. ISO 3166-1 alpha-2 codes

locationIdsArray of strings

Only consider data points belonging to any of these locationIds

dataPointTypesArray of strings

Types of datapoints you want inbox statistics for

Example: dataPointTypes=[PHOTO, REVIEW, CHECKIN]
directoryTypesArray of strings

Directories you want inbox statistics for

ratingsArray of strings

Ratings of datapoints you want inbox statistics for.

minActionDatestring

Only consider data points created after that date

maxActionDatestring

Only consider data points created before that date

minThreadActionDatestring

The min date of the last interaction with a DataPoint as unix timestamp in milliseconds

Example: minThreadActionDate=1514764800000
maxThreadActionDatestring

The max date of the last interaction with a DataPoint as unix timestamp in millisecond

Example: maxThreadActionDate=1514764800000
querystring

Filter by name

readboolean

Only consider data points that the current user has already read

repliedboolean

Only consider data points that are either replied or not replieds

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/data-points/statistics?businessIds=string&countries=string&locationIds=string&dataPointTypes=%5BPHOTO%2C+REVIEW%2C+CHECKIN%5D&directoryTypes=string&ratings=string&minActionDate=string&maxActionDate=string&minThreadActionDate=1514764800000&maxThreadActionDate=1514764800000&query=string&read=true&replied=true' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Datapoint statistics response Model

Example: {"totalCount":100,"photoCount":20,"postCount":30,"reviewCount":25,"checkinCount":10,"questionCount":5,"ratingCount":15,"unreadCount":8,"pendingApprovalCount":3,"averageRating":4.2,"directories":{"GOOGLE":{"REVIEW":10,"PHOTO":5,"QUESTION":2,"CHECKIN":"NOT_SUPPORTED"},"FACEBOOK":{"REVIEW":8,"PHOTO":3,"CHECKIN":12,"QUESTION":0}}}
response.​totalCountinteger(int32)

Total number of datapoints

Example: 100
response.​photoCountinteger(int32)

Number of photos

Example: 20
response.​postCountinteger(int32)

Number of posts

Example: 30
response.​reviewCountinteger(int32)

Number of reviews

Example: 25
response.​checkinCountinteger(int32)

Number of checkins

Example: 10
response.​questionCountinteger(int32)

Number of questions

Example: 5
response.​ratingCountinteger(int32)

Number of ratings

Example: 15
response.​unreadCountinteger(int32)

Number of unread datapoints

Example: 8
response.​pendingApprovalCountinteger(int32)

Number of replies pending approval

Example: 3
response.​averageRatingnumber(float)

Average rating obtained

Example: 4.2
response.​directoriesobject

Breakdown by directory

Example: {"GOOGLE":{"REVIEW":10,"PHOTO":5,"QUESTION":2,"CHECKIN":"NOT_SUPPORTED"},"FACEBOOK":{"REVIEW":8,"PHOTO":3,"CHECKIN":12,"QUESTION":0}}
Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "totalCount": 100,
    "photoCount": 20,
    "postCount": 30,
    "reviewCount": 25,
    "checkinCount": 10,
    "questionCount": 5,
    "ratingCount": 15,
    "unreadCount": 8,
    "pendingApprovalCount": 3,
    "averageRating": 4.2,
    "directories": { … }
  }
}

Get Data Points' time series

Request

Returns time series of Data Points

Security
accessToken or privateKey
Query
dataPointTypesArray of strings

Types of datapoints you want inbox statistics for

Example: dataPointTypes=[PHOTO, REVIEW, CHECKIN]
directoryTypesArray of strings

Directories you want data points time series for

businessIdsArray of strings

Ids of businesses you want data points for

zipstring

Only return Data Points time series for locations where zip starts with given parameter

ratingsArray of strings

Only return Data Points with a rating included in ratings

readboolean

Only show read/not read elements

repliedboolean

Only show elements you have/you have not replied to

countriesArray of strings

The countries you want data points for. ISO 3166-1 alpha-2 codes

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/data-points/timeseries?dataPointTypes=%5BPHOTO%2C+REVIEW%2C+CHECKIN%5D&directoryTypes=string&businessIds=string&zip=string&ratings=string&read=true&replied=true&countries=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

DataPoint Time Series Response Model

response.​timeseriesArray of objects(DataPointTimeSeriesValue)

A list of TimeSeriesValues

Example: [{"date":"string","datapoints":{"REVIEW":2,"PHOTO":1}}]
Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "timeseries": [ … ]
  }
}

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations