Keystone Developers
Open Keystone
API reference

Console API

Maps

5 endpoints.

GET/api/v1/admin/businesses/{business_id}/listings/{listing_id}/maps/performance

Per-listing Performance tab: 30-day metrics, keywords, tracked queries

Parameters

NameInTypeDescription
business_idrequiredpathstring (uuid)
listing_idrequiredpathstring (uuid)
authorizationheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_PerformanceData_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredPerformanceData
PerformanceData fields
FieldTypeDescription
businessIdrequiredstring (uuid)
listingIdrequiredstring (uuid)
generatedAtrequiredstring (date-time)
windowDaysrequiredinteger
staterequiredenumone of "ok", "syncing", "forbidden", "rankings_disabled", "unavailable"
groupsrequiredMetricGroup[]
MetricGroup[] fields

MetricGroup (not expanded)

keywordsMonthstring (date) | null
keywordsrequiredKeywordRow[]
KeywordRow[] fields

KeywordRow (not expanded)

queriesStaterequiredenumone of "ok", "syncing", "forbidden", "rankings_disabled", "unavailable"
queriesrequiredTrackedQuery[]
TrackedQuery[] fields

TrackedQuery (not expanded)

volumeAreastring | null
metadataResponseMetadata | null
ResponseMetadata fields
FieldTypeDescription
paginationPaginationMetadata | null
PaginationMetadata fields
FieldTypeDescription
limitrequiredinteger
next_cursorstring | null
prev_cursorstring | null
has_morerequiredboolean
has_prevbooleandefault false
total_countinteger | null
status_countsobject | null
object | null fields

Map of string to integer

lifecycle_countsLifecycleCounts | null
LifecycleCounts fields
FieldTypeDescription
leadintegerdefault 0
prospectintegerdefault 0
customerintegerdefault 0
former_customerintegerdefault 0
classification_countsClassificationCounts | null
ClassificationCounts fields
FieldTypeDescription
signalobject
object fields

Nested object (not expanded)

touchobject
object fields

Nested object (not expanded)

stageobject
object fields

Nested object (not expanded)

metaResponseMeta | null
ResponseMeta fields
FieldTypeDescription
totalinteger | null
total_countinteger | null
pageinteger | null
per_pageinteger | null
  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/listings/{listing_id}/maps/profile-data

Per-listing Profile data tab: the audit inventory with rule hints

Parameters

NameInTypeDescription
business_idrequiredpathstring (uuid)
listing_idrequiredpathstring (uuid)
authorizationheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_ProfileData_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredProfileData
ProfileData fields
FieldTypeDescription
businessIdrequiredstring (uuid)
listingIdrequiredstring (uuid)
generatedAtrequiredstring (date-time)
staterequiredenumone of "ok", "syncing", "forbidden", "rankings_disabled", "unavailable"
auditedOnstring (date) | null
groupsrequiredProfileGroup[]
ProfileGroup[] fields

ProfileGroup (not expanded)

rawAvailablebooleandefault false
extraobject | null
metadataResponseMetadata | null
ResponseMetadata fields

ResponseMetadata, expanded above.

metaResponseMeta | null
ResponseMeta fields

ResponseMeta, expanded above.

  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/listings/{listing_id}/maps/readiness

Per-listing Readiness tab: score, categories, recommendations

Parameters

NameInTypeDescription
business_idrequiredpathstring (uuid)
listing_idrequiredpathstring (uuid)
authorizationheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_ReadinessData_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredReadinessData
ReadinessData fields
FieldTypeDescription
businessIdrequiredstring (uuid)
listingIdrequiredstring (uuid)
generatedAtrequiredstring (date-time)
staterequiredenumone of "ok", "syncing", "forbidden", "rankings_disabled", "unavailable"
scoredOnstring (date) | null
overallMapsCategoryScore | null
MapsCategoryScore fields
FieldTypeDescription
categoryrequiredstring
scorerequiredinteger
bandrequiredenumone of "good", "warn", "bad", "muted", "default"
headlinerequiredstring
detailstring | null
categoriesrequiredMapsCategoryScore[]
MapsCategoryScore[] fields

MapsCategoryScore (not expanded)

recommendationsrequiredRecommendation[]
Recommendation[] fields

Recommendation (not expanded)

metadataResponseMetadata | null
ResponseMetadata fields

ResponseMetadata, expanded above.

metaResponseMeta | null
ResponseMeta fields

ResponseMeta, expanded above.

  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/listings/{listing_id}/maps/refresh

Populate Maps analytics for one listing now (audit → performance → quality → score)

Parameters

NameInTypeDescription
business_idrequiredpathstring (uuid)
listing_idrequiredpathstring (uuid)
authorizationheaderstring | null

Responses

202Successful Response
application/jsonSuccessResponse_RefreshData_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredRefreshData
RefreshData fields
FieldTypeDescription
scheduledrequiredboolean
reasonstring | null
metadataResponseMetadata | null
ResponseMetadata fields

ResponseMetadata, expanded above.

metaResponseMeta | null
ResponseMeta fields

ResponseMeta, expanded above.

  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/maps/summary

Maps performance across all managed listings of a business

Parameters

NameInTypeDescription
business_idrequiredpathstring (uuid)
authorizationheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_SummaryData_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredSummaryData
SummaryData fields
FieldTypeDescription
businessIdrequiredstring (uuid)
generatedAtrequiredstring (date-time)
windowDaysrequiredinteger
trendsrequiredTrend[]
Trend[] fields

Trend (not expanded)

rowsrequiredMetricRow[]
MetricRow[] fields

MetricRow (not expanded)

groupsrequiredMetricGroup[]
MetricGroup[] fields

MetricGroup (not expanded)

listingsrequiredListingSummary[]
ListingSummary[] fields

ListingSummary (not expanded)

metadataResponseMetadata | null
ResponseMetadata fields

ResponseMetadata, expanded above.

metaResponseMeta | null
ResponseMeta fields

ResponseMeta, expanded above.

  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.