Vendasta Multi-Location Analytics API is one of 38 APIs that Vendasta publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Analytics, Multi-Location, Franchise, Reporting, and gRPC. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
2 operations
across 2 paths,
and defines 45 schemas.
It is described by OpenAPI 3.0.0, at version 1.16.1.
Requests are made against a single base URL, https://prod.apigateway.co/grpc.
2 operations2 paths45 schemas2 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.0
API Version
1.16.1
Base URL
https://prod.apigateway.co/grpc
Authentication
OAuth 2.0
Resource Areas
1
Authentication & Security 1
Vendasta Multi-Location Analytics API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are v1QueryMetricsRequest (14 properties), v1ResourceMetricResult (6 properties), vendastatypesProperty (6 properties), v1FieldFilter (6 properties). Each schema is shown below with its type and property counts.
AlignmentPeriodCalendar
string
- UNSPECIFIED: No value has been specified. - CALENDARMINUTE: Align at minute boundaries - CALENDARHOUR: Align at hour boundaries - CALENDARDAY: Align at day b…
FieldFilterOperatorFunction
string
- NONE: No function will be applied to the values - ANY: Any value in the list must pass the filter - ALL: All values in the list must pass the filter
GroupByDimension
object
2 properties
GroupByExcludeCombination
object
1 property
GroupByLimit
object
3 properties
MeasureAggregate
object
Aggregate applies a SQL aggregation function to a measure field.
4 properties
MeasureAggregateOperator
string
- AVG: Calculate the average value. - COUNT: Count the number of rows. - SUM: Sum all values. - MIN: Get the minimum value. - MAX: Get the maximum value. - COU…
OrderByOrderColumn
object
2 properties
PropertyPIITag
string
PIITag defines potential PII tags. - PROPERTYPIITAGCLEAN: clean means the data is not PII or PD. - PROPERTYPIITAGPII: PII means Personally Identifiable Informa…
protobufAny
object
1 property
rpcStatus
object
3 properties
v1Alignment
string
- ALIGNNONE: No alignment. - ALIGNDELTA: Align and convert to delta metric type. This alignment is valid for delta metrics. Aligning an existing delta metric t…
v1AlignmentPeriod
object
2 properties
v1BusinessResourceId
object
A single business location identified by its account group ID.
1 property
v1CompositeFilter
object
A filter that merges multiple other filters using the given operator.
2 properties
v1CompositeFilterOperator
string
A composite filter operator. - OPERATORUNSPECIFIED: Unspecified. This value must not be used. - AND: The results are required to satisfy each of the combined f…
v1CustomAlignerConfig
object
2 properties
v1DateRange
object
4 properties
v1FieldFilter
object
6 properties
v1FieldFilterOperator
string
- OPERATORUNSPECIFIED: Unspecified. This value must not be used. - LESSTHAN: Less than. Requires that the field come first in orderby. - LESSTHANOREQUAL: Less…
v1Filter
object
3 properties
v1GetAvailableMetricsRequest
object
Request to retrieve the catalog of available analytics metrics for the given resources.
2 properties2 required
v1GetAvailableMetricsResponse
object
The catalog of available analytics metrics with their schemas.
1 property
v1GroupBy
object
3 properties
v1GroupByOperator
string
v1GroupResourceId
object
A group of businesses identified by a hierarchical path. Groups allow querying aggregate analytics across multiple business locations.
1 property
v1JWTResourceId
object
A JWT that encodes a specific user/business combination for authenticated end-user queries.
1 property
v1MarketId
object
One or more market IDs. Markets are geographic or logical groupings of businesses within a partner. When marketids is empty, the query returns data across ALL…
1 property
v1Measure
object
Measure selects or aggregates a field from the metric's available measures. Use GetAvailableMetrics to discover which measure names are valid for each metric.…
2 properties
v1MetricDescription
object
Description of a queryable analytics metric, including its available measures, dimensions, and time field.
5 properties
v1MetricResult
object
A single row of metric data with dimension value, measure values, and optional nested results.
3 properties
v1Metrics
object
A list of metric result rows.
1 property
v1Order
string
v1OrderBy
object
1 property
v1QueryMetricsRequest
object
Request to query analytics metrics for multi-location businesses with flexible measures, dimensions, time alignment, filtering, grouping, and pagination.
14 properties3 required
v1QueryMetricsResponse
object
Response containing analytics metric results for each requested resource.
1 property
v1ResourceId
object
ResourceId identifies the scope of a query. Exactly one resource type must be set. Each resource type determines what data is returned and how it is aggregated.
5 properties
v1ResourceMetricResult
object
Analytics result for a single resource, including data, schemas, and pagination cursor.
6 properties
v1SalesTeam
object
One or more sales team IDs for querying analytics scoped to sales team assignments.
1 property
v1TypedValue
object
A message that can hold any of the supported value types.
2 properties
v1UnaryFilter
object
2 properties
v1UnaryFilterOperator
string
A unary operator. - OPERATORUNSPECIFIED: Unspecified. This value must not be used. - ISNAN: Test if a field is equal to NaN. - ISNULL: Test if an expression ev…
vendastatypesProperty
object
6 properties
vendastatypesPropertyType
string
vendastatypesSchema
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Vendasta Multi-Location Analytics API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
