Skip to content
API Reference
/
Locations Data
/
Get Location's Visibility Index

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

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

Update EV Dynamic Data

Request

Update EV Charging data for a given EV Charging Station.

Security
accessToken or privateKey
Path
idstringrequired

The uberall unique id of the EV Charging station for which you want to update information.

uidstringrequired

The UID for the EV Charging station

Query
statusstringrequired

Query based on the location status

Body*/*required

A EvStatus object

string

EvStatus Enum Model

Enum"AVAILABLE""BLOCKED""CHARGING""INOPERATIVE""OUTOFORDER""PLANNED""REMOVED""RESERVED""UNKNOWN"
curl -i -X PATCH \
  'https://docs.uberall.com/_mock/apis/swagger/locations/{id}/ev-data/{uid}?status=string' \
  -H 'Content-Type: */*' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d AVAILABLE

Responses

Request successfully sent to eco-movement

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.​locationobject

Location

response.​uidstring

UID

response.​statusstring

Status

Response
No content

Get Location's Visibility Index

Request

Get the latest location's visibility index

Security
accessToken or privateKey
Path
idstringrequired

The uberall unique id for the location

Query
daysstring

Use days to get the visibility index from as many days ago

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/locations/{id}/visibility-indexes?days=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Visibility indexes successfully retrieved

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

The actual response object of the response

response.​visibilityIndexobject

VisibilityIndex Model

Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "visibilityIndex": { … }
  }
}

DEPRECATED - Get Location's Data PointsDeprecated

Request

Deprecated. Use https://uberall.com/en/developers/apiDocumentation#_api_data-points-GET instead.

Security
accessToken or privateKey
Path
idstringrequired

The uberall unique ID of the location you want to inbox items for

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/locations/{id}/datapoints' \
  -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

The actual response object of the response

response.​inboxobject

Inbox Response Model

Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "inbox": { … }
  }
}

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