Skip to content
API Reference/
/
Get report by id and toke...

Uberall API (20250708)

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

https://uberall.com/api/

Mock Server

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

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 Point Filters

Products - Data Points - Data Point Filters

Operations

Data Points

Products - Data Points

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Near Me Check

Products - Near Me Check

Operations

Create a report

Request

Creates a report and fetches the data in the background

Security
publicKey
Bodyapplication/json
categoryIdstringrequired

id of the Uberall category

countrystringrequired

country in two letter code

namestringrequired

name of the location

streetAndNostringrequired

street and street number of the location

zipstring or null

zip code of the location

citystring or null

city of the location

latnumber or null(double)

latitude

lngnumber or null(double)

longitude

provincestring or null

province of the location

curl -i -X POST \
  https://near-me-check.uberall.com/api/report \
  -H 'Content-Type: application/json' \
  -H 'publicKey: YOUR_API_KEY_HERE' \
  -d '{
    "categoryId": "213",
    "country": "DE",
    "name": "Uberall",
    "streetAndNo": "Hussitenstraße 32-33",
    "zip": "13355",
    "city": "Berlin",
    "phone": "030 208479320"
  }'

Responses

Representation of the successful created report

Bodyapplication/json
Response
application/json
{
  "id": 1,
  "token": "Qxcymb4T4Sr51hOz",
  "location": {
    "alreadyManaged": true,
    "name": "Uberall",
    "categoryId": 213,
    "address": { … }
  },
  "dateCreated": "2023-04-25T13:33:04.093+00:00",
  "statuses": {
    "locationAccuracyStatus": "IN_PROGRESS",
    "listingsDetailsStatus": "IN_PROGRESS"
  },
  "uncheckedDirectories": []
}

Get report by id and token

Request

Security
publicKey
Path
idinteger(int32)required

id returned by the POST

Example: 1
Query
tokenstringrequired

token returned by the POST

Example: token=Qxcymb4T4Sr51hOz
curl -i -X GET \
  'https://near-me-check.uberall.com/api/report/1?token=Qxcymb4T4Sr51hOz' \
  -H 'publicKey: YOUR_API_KEY_HERE'

Responses

Report with given id

Bodyapplication/json
idinteger(int64)

id, used in GET requests

addressobject
categoryIdinteger(int64)

Uberall category id

tokenstring

randomly created token, used in GET requests

alreadyManagedIdinteger(int64)

id of already managed Uberall location

namestring

location name

websitestring

location website

phonestring

location phone

dateCreatedstring(date-time)MM/dd/yyyy HH:mm:ss

date created

locationAccuracyobject
listingsDetailsobject
benchmarkGeographystring

the chosen geography for benchmark (ex. zip, city, province)

benchmarkCategoryinteger(int64)

the chosen category for benchmark

uncheckedDirectoriesArray of strings

list of unchecked directories

Response
application/json
{
  "id": 1,
  "token": "Qxcymb4T4Sr51hOz",
  "benchmark": {
    "category": { … },
    "geography": { … }
  },
  "location": {
    "alreadyManaged": true,
    "name": "Uberall",
    "categoryId": 213,
    "address": { … }
  },
  "dateCreated": "2023-04-25T13:33:04.000+00:00",
  "statuses": {
    "locationAccuracyStatus": "FINISHED",
    "listingsDetailsStatus": "FINISHED"
  },
  "locationAccuracy": {
    "dataFields": { … },
    "listings": { … }
  },
  "listingsDetails": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "uncheckedDirectories": [
    "YALWA",
    "OEFFNUNGSZEITENBUCH",
    "CYLEX",
    "TOMTOM",
    "NEXT_DOOR",
    "GO_YELLOW",
    "STADTBRANCHENBUCH",
    "MEINESTADT",
    "FOURSQUARE",
    "AUSKUNFT",
    "BAIDU",
    "DIALO",
    "TRIP_ADVISOR",
    "MARKTPLATZ_MITTELSTAND",
    "BROWNBOOK",
    "BUNDES_TELEFONBUCH",
    "WAZE",
    "BING",
    "BUSINESSBRANCHENBUCH",
    "FIND_OPEN",
    "KOOMIO",
    "UNTERNEHMENSAUSKUNFT",
    "APPLE_MAPS",
    "NOKIA_HERE",
    "BRANCHENBUCH_DEUTSCHLAND",
    "GOOGLE_MAPS",
    "GO_LOCAL",
    "WO_GIBTS_WAS",
    "UBER",
    "HOLIDAY_CHECK",
    "HUAWEI",
    "SIRI",
    "MICROSOFT_CORTANA",
    "GOOGLE_ASSISTANT",
    "ALEXA"
  ]
}

Social Posting

Products - Social Posting

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Templates

Products - Response Library - Templates

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

Locations

Locations

Operations