Get profile completeness

Request

Retrieves the average profile completeness score and a breakdown of locations by completeness classification (REQUIRED, BASIC, ADVANCED, BONUS, COMPLETE, OTHER) for filtered locations. Reflects current state (no date range).

Query

vany

API version. Defaults to the latest version. Versions older than 20191203 additionally return missingFields, directoriesMissingConnect and isLegacy.

Example:v=20191203

filterCategoryany

Filter strategy to use for scoping locations

Enum:"location""business""labels""location-groups"

locationIdsany

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

businessIdsany

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

labelsany

Label names (used when filterCategory=labels)

locationGroupIdsany

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

excludedLocationIdsany

Comma-separated location IDs to exclude from results

excludedBusinessIdsany

Comma-separated business IDs to exclude from results

excludedLabelsany

Label names to exclude from results

excludedLocationGroupIdsany

Location group IDs to exclude from results

curl -i -X GET \
  'https://uberall.com/api/dashboard/profile-completeness?v=20191203&filterCategory=location&locationIds=%7BlocationIds%7D&businessIds=%7BbusinessIds%7D&labels=%7Blabels%7D&locationGroupIds=%7BlocationGroupIds%7D&excludedLocationIds=%7BexcludedLocationIds%7D&excludedBusinessIds=%7BexcludedBusinessIds%7D&excludedLabels=%7BexcludedLabels%7D&excludedLocationGroupIds=%7BexcludedLocationGroupIds%7D'

Responses

Profile completeness statistics with classification breakdown. Versions older than 20191203 also include missingFields, directoriesMissingConnect and isLegacy.

Bodyapplication/json

One of:

Profile completeness statistics with location classification breakdown

averageProfileCompletenessany, (int32)required

Average profile completeness percentage (0-100)

Example:82

countLocationsMissingDataany, (int32)required

Number of locations with missing data

locationClassificationCountsobjectrequired

Location counts by classification: REQUIRED, BASIC, ADVANCED, BONUS, COMPLETE, OTHER

Response

{
  "averageProfileCompleteness": 82,
  "countLocationsMissingData": null,
  "locationClassificationCounts": {
    "property1": null,
    "property2": null
  }
}