Visier Data Model API
Discover the objects that make up your Visier solution and provide detailed information on the object's schema.You can retrieve detailed information about objects in Visier by retrieving a list of all objects or retrieving information about an object by object ID.The types of objects you can retrieve using the data model API are: * Analytic objects * Properties * Dimensions * Selection concepts * Metrics * Predictions * Vee sample questions and categories
Visier Data Model API is one of 51 APIs that Visier publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Data Model. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 46 operations across 35 paths, and defines 102 schemas. It is described by OpenAPI 3.2.0, at version 22222222.99201.3040.
Requests are made against the base URL https://{vanity_name}.api.visier.io.
46 operations
35 paths
102 schemas
3 DELETE32 GET4 PATCH4 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Visier Data Model API declares
4 security schemes
for authenticating requests.
An API key is passed in the cookie as VisierASIDToken (CookieAuth).
An API key is passed in the header as apikey (ApiKeyAuth).
It accepts HTTP bearer tokens (BearerAuth).
It supports OAuth 2.0 (OAuth2Auth) using the authorizationCode and password flows, exposing 2 scopes.
By default, every request must be authenticated.
Paths & Operations 46
Across 35 paths, the API surfaces 46 operations — 3 DELETE, 32 GET, 4 PATCH, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
DataModel 46
Discover the objects that make up your Visier solution and provide detailed information on the object's schema. You can retrieve detailed information about objects in Visier by re…
GET
/v1/data/model/analytic-objects
Retrieve a list of analytic objects
GET
/v1/data/model/analytic-objects/{id}
Retrieve an analytic object by ID
GET
/v1/data/model/analytic-objects/{id}/metrics
Retrieve a list of metrics for an analytic object by ID
GET
/v1/data/model/analytic-objects/{objectId}/dimensions
Retrieve a list of dimensions
POST
/v1/data/model/analytic-objects/{objectId}/dimensions/{dimensionId}/mappings/validate
Validate a member map's unmapped dimension members by ID
GET
/v1/data/model/analytic-objects/{objectId}/dimensions/{dimensionId}/members
Retrieve a list of dimension members
GET
/v1/data/model/analytic-objects/{objectId}/dimensions/{dimensionId}/members/{id}
Retrieve a dimension member
GET
/v1/data/model/analytic-objects/{objectId}/dimensions/{id}
Retrieve a dimension by ID
GET
/v1/data/model/analytic-objects/{objectId}/properties
Retrieve a list of properties
GET
/v1/data/model/analytic-objects/{objectId}/properties/{id}
Retrieve a property by ID
GET
/v1/data/model/analytic-objects/{objectId}/selection-concepts
Retrieve an analytic object's selection concepts
GET
/v1/data/model/analytic-objects/{objectId}/selection-concepts/{id}
Retrieve an analytic object's selection concept by ID
GET
/v1/data/model/currencies
Retrieve all currencies
GET
/v1/data/model/currencies/{id}
Retrieve a currency
GET
/v1/data/model/currencies/{id}/rates
Retrieve all exchange rates for a currency
GET
/v1/data/model/currencies/{id}/rates/{toId}
Retrieve exchange rates from one currency to another currency
PATCH
/v1/data/model/dimensions
Update dimensions
GET
/v1/data/model/metrics
Retrieve a list of metrics
GET
/v1/data/model/metrics/{id}
Retrieve a metric by ID
GET
/v1/data/model/metrics/{metricId}/dimensions
Retrieve a metric's dimensions
GET
/v1/data/model/metrics/{metricId}/selection-concepts
Retrieve a metric's selection concepts
GET
/v1/data/model/plan-models
Retrieve a list of planning models
GET
/v1/data/model/plan-models/{id}
Retrieve a planning model by ID
GET
/v1/data/model/plan-models/{id}/metrics
Retrieve metrics by planning model ID
GET
/v1/data/model/plan-models/{modelId}/plans
Retrieve a list of plans by planning model ID
GET
/v1/data/model/plan-models/{modelId}/plans/{id}
Retrieve a plan by planning model ID and plan ID
GET
/v1/data/model/predictions
Retrieve a list of predictions
GET
/v1/data/model/predictions/{id}
Retrieve a prediction by ID
PUT
/v1/data/model/properties
Replace properties
POST
/v1/data/model/properties
Create properties
DELETE
/v1/data/model/properties
Delete properties
PATCH
/v1/data/model/properties
Update properties
GET
/v1/data/model/vee/sample-question-categories
Retrieve a list of all Vee question categories
PUT
/v1/data/model/vee/sample-question-categories
Update Vee question categories
POST
/v1/data/model/vee/sample-question-categories
Create Vee question categories
DELETE
/v1/data/model/vee/sample-question-categories
Delete Vee question categories
PATCH
/v1/data/model/vee/sample-question-categories
Partially update Vee question categories
GET
/v1/data/model/vee/sample-question-categories/{questionCategoryId}
Retrieve a Vee question category's details
GET
/v1/data/model/vee/sample-questions
Retrieve a list of all Vee sample questions
PUT
/v1/data/model/vee/sample-questions
Update Vee sample questions
POST
/v1/data/model/vee/sample-questions
Add Vee sample questions
DELETE
/v1/data/model/vee/sample-questions
Delete Vee sample questions
PATCH
/v1/data/model/vee/sample-questions
Patch Vee sample questions
GET
/v1/data/model/vee/sample-questions/{questionId}
Retrieve a Vee sample question's details
GET
/v1/planning/model/plans
Retrieve a list of plans
GET
/v1/planning/model/plans/{id}
Retrieve a plan's details
Schemas 102
The contract defines 102 schemas that model the data the API accepts and returns. The most detailed are dataservices.datamodel.PredictionDTO (19 properties), dataservices.datamodel.AnalyticObjectDTO (12 properties), dataservices.datamodel.MetricDTO (10 properties), dataservices.datamodel.DimensionDTO (9 properties). Each schema is shown below with its type and property counts.
servicing.VeeQuestionDeleteDefinitionsByTenantDTO
object
Information about the sample question and the context of the API request, such as the tenant code and project ID.
3 properties
servicing.VeeQuestionChangeFailureDTO
object
The list of failed changes.
8 properties
dataservices.datamodel.PropertyDTO
object
Properties are qualities of an analytic object.
8 properties
servicing.objectconfiguration.ObjectsBulkChangeResponseDTO
object
2 properties
dataservices.datamodel.DimensionsDTO
object
A collection of dimensions.
1 property
planning.GetPlanListResponseDTO
object
A collection of plans.
2 properties
dataservices.datamodel.DimensionMappingValidationExecutionDTO
object
Instruction to execute a mapping validation query
2 properties
dataservices.datamodel.PlanningModelDTO
object
The basic information about the planning model. A planning model captures the planning intent, plan items, and the relationship between them.
3 properties
dataservices.datamodel.PlanningPlansDTO
object
A collection of plan definitions.
1 property
planning.PlanSegmentLevelMemberListDTO
object
A collection of dimension members.
3 properties
servicing.SampleQuestionAPIResponseDTO
object
Information about the sample question.
6 properties
servicing.objectconfiguration.CalculatedPropertyTypeDTO
object
2 properties
dataservices.datamodel.PredictionDTO
object
A prediction is a forecast of future events with advanced machine learning models.
19 properties
servicing.VeeQuestionCategoryChangeFailureDTO
object
The list of failed changes.
7 properties
dataservices.datamodel.MembersDTO
object
A collection of members.
1 property
dataservices.datamodel.SelectionConceptDTO
object
Selection concepts select a population of subject members of a given subject or event.
6 properties
servicing.VeeQuestionCategoryDeleteDefinitionsByTenantDTO
object
Information about the question category and the context of the API request, such as the tenant code and project ID.
3 properties
dataservices.common.MemberValuesDTO
object
Member filter values are discrete member references in a dimension filter. You can define included and excluded members simultaneously. This is typically done…
2 properties
dataservices.datamodel.PropertyReferenceDTO
object
The name and qualifying path of a property to query.
2 properties
dataservices.datamodel.CurrencyRatesDTO
object
A collection of currency exchange rates. Note: Currencies may have different exchange rates in different time intervals, depending what rate data is stored in…
1 property
dataservices.datamodel.ScenarioOrSnapshotDTO
object
The unique identifier and display name for plan scenarios and snapshots.
2 properties
dataservices.datamodel.PlanningModelsDTO
object
A collection of planning modules.
1 property
planning.PlanItemDTO
object
A plan item is a metric in your plan. The available plan items depend on the planning model.
3 properties
dataservices.datamodel.TagMapElementDTO
object
Tag identifier and display name pair.
2 properties
servicing.objectconfiguration.PropertyBulkDeleteResponseDTO
object
Results of a bulk delete operation.
2 properties
planning.PlanWithSchemaDTO
object
Details about the plan, including its schema.
3 properties
dataservices.datamodel.ParameterDefinitionDTO
object
Parameters generalize object definitions so that end users can provide values at query run time.
4 properties
dataservices.datamodel.DimensionDTO
object
A dimension organizes unique values of an attribute into a list or a hierarchical structure for use as a filter or group-by in your solution.
9 properties
servicing.VeeQuestionsDeleteDefinitionsDTO
object
The Vee sample question to delete.
1 property
dataservices.datamodel.CurrenciesDTO
object
A collection of currencies.
3 properties
servicing.objectconfiguration.DependentDTO
object
Details about a dependent object related to the property to delete.
3 properties
dataservices.datamodel.MetricsDTO
object
A collection of metrics.
1 property
servicing.QuestionCategoryAPIResponseDTO
object
Information about the Vee question category.
4 properties
servicing.objectconfiguration.PropertyChangeDefinitionDTO
object
9 properties
dataservices.datamodel.PlanningConceptFilterContextDTO
object
A plan context defined using a selection concept.
1 property
servicing.objectconfiguration.PropertiesDeleteDefinitionsDTO
object
Property deletion options.
3 properties
servicing.objectconfiguration.PropertiesChangeDefinitionsDTO
object
1 property
servicing.SampleQuestionsAPIResponseDTO
object
The list of Vee sample questions.
1 property
servicing.VeeQuestionCategoryChangeSuccessDTO
object
The list of successful changes.
5 properties
dataservices.datamodel.AnalyticObjectsDTO
object
A collection of analytic objects
1 property
servicing.VeeQuestionCategoriesChangeDefinitionsDTO
object
The changes to Vee question categories.
1 property
dataservices.datamodel.PlanningPlanContextDTO
object
The filter context for a plan. Plan contexts are defined using a set of hierarchy members or a concept.
2 properties
dataservices.datamodel.PopulationConfigurationDTO
object
A set of property and dimension references configured by Visier or an administrator to tell the platform what properties and dimensions to use when doing popul…
3 properties
dataservices.datamodel.AggregationTypeOptionDTO
object
The definition of an aggregation option.
5 properties
dataservices.datamodel.SelectionConceptReferenceDTO
object
The name and qualifying path of a selection concept to query.
2 properties
planning.PlanTimePeriodDTO
object
A time period in the plan.
2 properties
servicing.UserGroupAssignmentDTO
object
The Vee sample question's assigned user groups.
1 property
servicing.QuestionCategoriesAPIResponseDTO
object
The Vee question categories.
1 property
dataservices.datamodel.PlanParameterDefinitionDTO
object
The definition of a plan parameter. These parameters resolve planning model metrics to a specific plan and scenario or snapshot values at query runtime.
4 properties
servicing.objectconfiguration.PropertyDeleteSuccessDTO
object
Details about a successful property deletion.
6 properties
servicing.objectconfiguration.ObjectChangeSuccessDTO
object
4 properties
servicing.VeeQuestionCategoriesBulkChangeResponseDTO
object
The results of the bulk change operation.
2 properties
servicing.objectconfiguration.DimensionChangeDefinitionDTO
object
4 properties
servicing.objectconfiguration.ObjectChangeFailureDTO
object
6 properties
dataservices.datamodel.PlanningHierarchyFilterContextDTO
object
A plan context defined using hierarchy members
3 properties
servicing.objectconfiguration.PropertyDeleteFailureDTO
object
Details about a failed property deletion.
8 properties
servicing.objectconfiguration.TagsDTO
object
Wrapper to distinguish between an empty list and a null/unset list.
1 property
dataservices.common.DimensionMemberReferenceDTO
object
The members of a dimension.
2 properties
dataservices.datamodel.MemberDTO
object
A member is an element of a dimension. Dimension members are organized hierarchically. For example, Argentina is a member of the Location dimension at the Coun…
6 properties
planning.ScenarioInfoDTO
object
Information about a plan's scenario.
3 properties
servicing.VeeQuestionChangeDefinitionDTO
object
The Vee sample question details.
5 properties
servicing.VeeQuestionChangeDefinitionsByTenantDTO
object
Information about the sample question and the context of the API request, such as the tenant code and project ID.
3 properties
servicing.VeeQuestionChangeSuccessDTO
object
The list of successful changes.
7 properties
servicing.objectconfiguration.PropertyTypeDTO
object
2 properties
dataservices.datamodel.PredictionsDTO
object
A collection of predictions.
1 property
dataservices.datamodel.MemberParameterDefinitionDTO
object
The definition of a filter parameter. These elements are returned as part of the definition for metrics that include parameters in their definition.
6 properties
servicing.VeeQuestionCategoryChangeDefinitionsByTenantDTO
object
Information about the question category and the context of the API request, such as the tenant code and project ID.
3 properties
planning.CollaborationInfo
object
Information about the plan's collaborations.
5 properties
planning.PlanDataLoadErrorDTO
object
An error encountered while loading plan data.
3 properties
servicing.objectconfiguration.SimplePropertyTypeDTO
object
1 property
dataservices.datamodel.PropertiesDTO
object
A collection of properties.
1 property
dataservices.datamodel.CurrencyDTO
object
Information about a currency type.
4 properties
servicing.CategoryIconDTO
object
An icon associated with the question category.
2 properties
dataservices.datamodel.NumericParameterDefinitionDTO
object
The definition of a numeric parameter. These elements are returned as part of the query definition for metric parameter values.
6 properties
planning.MemberDTO
object
A single member at a specific dimension level within the plan's context path.
5 properties
dataservices.datamodel.ValidityRangeDTO
object
A pair of values that represent the time interval to which the data is valid. The validity range is defined in Unix epoch format and UTC timezone. Note: Epochs…
2 properties
servicing.objectconfiguration.PropertyChangeDefinitionsByTenantDTO
object
3 properties
servicing.objectconfiguration.DimensionsChangeDefinitionsDTO
object
1 property
servicing.VeeQuestionCategoryChangeDefinitionDTO
object
The Vee question category details.
3 properties
dataservices.datamodel.CurrencyRateDTO
object
Information about a currency exchange rate.
5 properties
dataservices.datamodel.SelectionConceptsDTO
object
A collection of selection concepts
1 property
planning.PlanInfoDTO
object
Information about a plan and its scenarios.
7 properties
dataservices.datamodel.AggregationTypeParameterDTO
object
The definition of an aggregation parameter. These parameters resolve metrics that use aggregation parameters. For example, Visier Benchmarks metrics often use…
4 properties
planning.PlanSegmentLevelDTO
object
A dimension and dimension level that segments the plan.
5 properties
servicing.objectconfiguration.DimensionChangeDefinitionsByTenantDTO
object
3 properties
dataservices.datamodel.DimensionReferenceDTO
object
The name and qualifying path of a dimension to query.
2 properties
servicing.VeeQuestionsBulkChangeResponseDTO
object
The results of the bulk change operation.
2 properties
planning.PlanSegmentLevelMemberDTO
object
A member in the dimension.
4 properties
servicing.VeeQuestionCategoriesDeleteDefinitionsDTO
object
The Vee question categories to delete.
1 property
dataservices.datamodel.LevelDTO
object
Levels are the hierarchical structure of members within a dimension.
3 properties
servicing.QuestionCategoryBasicInformationDTO
object
Information that identifies and describes the question category, such as its display name and description.
2 properties
Status
object
The response structure for errors.
5 properties
dataservices.datamodel.DimensionMappingValidationDTO
object
4 properties
dataservices.datamodel.ObjectReferenceDTO
object
A link between one analytic object and another. An ObjectReference allows you to discover the relationships between analytic objects. In some queries, you may…
7 properties
servicing.VeeQuestionsChangeDefinitionsDTO
object
The changes to Vee sample questions.
1 property
servicing.VersionInformationDTO
object
The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in y…
3 properties
dataservices.datamodel.AnalyticObjectDTO
object
Analytic objects are the various items that users can analyze in Visier. Analytic objects include subjects, events, and overlays.
12 properties
planning.PlanContextDTO
object
The populations included in this plan.
1 property
planning.PlanSchemaDTO
object
Information about a plan's schema.
5 properties
servicing.objectconfiguration.PropertyDeleteDefinitionsByTenantDTO
object
The properties to delete for a specific tenant.
3 properties
dataservices.datamodel.PlanningPlanDTO
object
The definition of a plan. Plans are defined on planning models, and each plan may define multiple scenarios or snapshots.
7 properties
dataservices.datamodel.MetricDTO
object
A metric is a calculation based on one or more attribute values of analytic objects.
10 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Visier 12
Other APIs Visier publishes across the network.
Visier Query MCP Server
Visier Analytic Objects V2 API
Visier Basic Authentication API
Visier Benchmarks API
Visier Concepts V2 API
Visier Consolidated Analytics API
Visier Data And Job Handling API
Visier Data Export Connectors API API
Visier Data Intake API
Visier Data Query API
Visier Data Upload API
Visier Data Version Export API
#Data Model
Where this information came from
This is an independent, third-party profile of Visier Data Model 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.