How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

mParticle Data Plan Version API

Endpoints for versioning Data Plans

mParticle Data Plan Version API is one of 10 APIs that mParticle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Data Plan Version. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 4 operations across 2 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.mparticle.com/platform/v2/workspaces/{workspace_id}/plans.

4 operations 2 paths 21 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://s2s.mparticle.com/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

mParticle Data Plan Version API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 4

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

Data Plan Version 4

Endpoints for versioning Data Plans

GET
/{plan_id}/versions/{plan_version}
Get a Single Data Plan Version
get-plan-version 2 params → 200401403404429
PATCH
/{plan_id}/versions/{plan_version}
Update Data Plan Version
update-plan-version 2 params body → 200400401403404429
DELETE
/{plan_id}/versions/{plan_version}
Delete Data Plan Version
delete-plan-version 2 params → 204400401403404429
POST
/{plan_id}/versions
Create a Data Plan Version
create-plan-version 1 param body → 200400401403429

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are DataPlanVersion (10 properties), DataPlanTransformation (7 properties), SchemaError (6 properties), DataPlanPatch (4 properties). Each schema is shown below with its type and property counts.

DataPlanVersion
object
10 properties
DataPoint
object
3 properties 2 required
SchemaError
object
6 properties 3 required
ProductAction
string
DataPointMatch
object
2 properties 2 required
VersionDocument
object
This is the actual data plan, since a data plan can have many versions.
3 properties
CustomEventCriteria
object
2 properties 2 required
ErrorList
object
1 property
Error
object
1 property
DataPlanTransformation
object
7 properties
DataPointValidator
object
2 properties 2 required
MatchType
string
ActivatedEnvironment
string
Data plan can be active in development, production & development (production), or neither. 'none' indicates it's inactive.
Criteria
SchemaErrorList
object
1 property
SchemaKeyword
string
DataPlanPatch
object
4 properties
ScreenViewEventCriteria
object
1 property 1 required
CommerceActionEventCriteria
object
Data point match criteria object for commerce action events
1 property
PromotionAction
string
UserAttributeCriteria
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mparticle-data-plan-version-api-openapi.yml Raw ↑

Other APIs mParticle publishes across the network.

mParticle Profile API
mParticle Platform API
mParticle Warehouse Sync API
mParticle Data Plan API
mParticle Events API
mParticle Identify API
mParticle Login API
mParticle Logout API
mParticle Modify API
Where this information came from

This is an independent, third-party profile of mParticle Data Plan Version 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.