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 API

Endpoints for managing Data Plans

mParticle Data Plan 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. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 6 operations across 3 paths, and defines 38 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.

6 operations 3 paths 38 schemas 1 DELETE2 GET1 PATCH2 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 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

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

Data Plan 6

Endpoints for managing Data Plans

GET
/
Get All Plans
get-plans → 200400401403404429
POST
/
Create Data Plan
create-plan body → 200400401403429
GET
/{plan_id}
Get a Single Plan
get-plan 1 param → 200401403429
DELETE
/{plan_id}
Delete Data Plan
delete-plan 1 param → 204401403404429
PATCH
/{plan_id}
Update Data Plan
update-plan 1 param body → 200400401403404429
POST
/validate
Validate Event Batch
validate-plan-document body → 200400401403429

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are Mparticle_S2s_Events_Oas_DeviceInformation (45 properties), Mparticle_S2s_Events_Oas_Batch (23 properties), Mparticle_S2s_Events_Oas_CommonEventData (19 properties), Mparticle_S2s_Events_Oas_DeviceCurrentState (17 properties). Each schema is shown below with its type and property counts.

Mparticle_S2s_Events_Oas_ApplicationInformation
object
7 properties
DataPlanVersion
object
10 properties
DataPoint
object
3 properties 2 required
Mparticle_S2s_Events_Oas_DataPlanContext
object
2 properties 1 required
Mparticle_S2s_Events_Oas_GeoLocation
object
3 properties 2 required
Mparticle_S2s_Events_Oas_DeviceCurrentState
object
17 properties
SchemaError
object
6 properties 3 required
ProductAction
string
Mparticle_S2s_Events_Oas_GDPRConsentState
object
6 properties 6 required
Mparticle_S2s_Events_Oas_BatchContext
object
1 property
Mparticle_S2s_Events_Oas_BaseEvent
object
2 properties
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
Mparticle_S2s_Events_Oas_SourceInformation
object
5 properties
Mparticle_S2s_Events_Oas_EventType
string
Mparticle_S2s_Events_Oas_CommonEventData
object
19 properties
Mparticle_S2s_Events_Oas_Batch
object
23 properties 1 required
DataPlanTransformation
object
7 properties
DataPointValidator
object
2 properties 2 required
Error
object
1 property
Mparticle_S2s_Events_Oas_DeviceInformation
object
45 properties
MatchType
string
Mparticle_S2s_Events_Oas_ConsentState
object
1 property 1 required
ActivatedEnvironment
string
Data plan can be active in development, production & development (production), or neither. 'none' indicates it's inactive.
Mparticle_S2s_Events_Oas_EventSystemNotificationInfo
object
1 property 1 required
Criteria
SchemaErrorList
object
1 property
SchemaKeyword
string
Mparticle_S2s_Events_Oas_AttributionInfo
object
3 properties 3 required
DataPlan
object
8 properties
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
DataPlanVersionList
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs mParticle publishes across the network.

mParticle Profile API
mParticle Platform API
mParticle Warehouse Sync API
mParticle Data Plan Version 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 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.