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 Computations API

The Computations API from Yext — 2 operation(s) for computations.

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

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

This API exposes 4 operations across 2 paths, and defines 15 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 2 paths 15 schemas 2 GET2 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 Computations 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 2 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Computations 4
POST
/accounts/{accountId}/computations
Computations: Create Operation
createOperation 3 params body → 200default
GET
/accounts/{accountId}/computations
Computations: List Operations
listOperations 5 params → 200default
POST
/accounts/{accountId}/computations/{operationUid}
Computations: Cancel Operation
cancelOperation 4 params → 200default
GET
/accounts/{accountId}/computations/{operationUid}
Computations: Get Operation
getOperation 4 params → 200default

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Operation (10 properties), ResponseError (4 properties), CreateOperationRequest (3 properties), ResponseMeta (1 property). Each schema is shown below with its type and property counts.

EntityProfileScope
ResponseMetaWithError
SavedFilterScope
FieldBehavior
string
Defines the field editing mode for a blank field or for a field which has content. If USEAUTOMATICCOMPUTATIONSBEHAVIOR is chosen, the behavior will match that…
EntityProfileSearchScope
TargetFields
object
1 property
Operation
object
10 properties
EntityTypeScope
OperationDefinitionResponseOptions
CreateOperationRequest
object
3 properties 1 required
TriggerFields
object
1 property
ResponseMeta
object
1 property
EntityScope
OperationDefinitionOptions
ResponseError
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-computations-api-openapi.yml Raw ↑

Other APIs Yext publishes across the network.

Yext Account Settings API
Yext Accounts API
Yext Administrative API API
Yext Analytics 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