Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yext Analytics API

The Analytics API from Yext — 4 operation(s) for analytics.

Yext Analytics API is one of 23 APIs that Yext publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against a single base URL, https://api.yextapis.com/v2.

4 operations 4 paths 6 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.yextapis.com/v2
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Yext Analytics API declares 2 security schemes for authenticating requests. An API key is passed in the query as api_key (api_key). An API key is passed in the header as api-key (api-key). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Analytics 4
GET
/accounts/{accountId}/analytics/catalog
Catalog
getCatalog 2 params → 200default
GET
/accounts/{accountId}/analytics/maxdates
Max Dates
getMaxDates 2 params → 200default
POST
/accounts/{accountId}/analytics/reports
Reports
createReports 4 params body → 200default
GET
/accounts/{accountId}/analytics/standardreports/{reportId}
Report Status
reportStatus 3 params → 200default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are AnalyticsFilter (102 properties), ResponseError (4 properties), CreateReportRequestBody (3 properties), Metric (2 properties). Each schema is shown below with its type and property counts.

Metric
object
2 properties
ResponseMeta
object
1 property
ResponseError
object
4 properties
AnalyticsFilter
object
102 properties
ResponseMetaWithError
CreateReportRequestBody
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-analytics-api-openapi.yml Raw ↑

Other APIs Yext publishes across the network.

Yext Account Settings API
Yext Accounts API
Yext Administrative API API
Yext Computations API
Yext Configuration API
Yext Connectors API
Yext Content API API
Yext Domains API
Yext Health Check API
Yext Knowledge Manager API
Yext Licenses API
Yext Listings API