Data Planning API

curl --location --request GET 'https://api.mparticle.com/platform/v2/workspaces/{{workspace_id}}/plans' \
--header 'Authorization: Bearer {{jwt_token}}'

import { DataPlanService } from '@mparticle/data-planning-node';

const dataPlanService = new DataPlanService({
    workspaceId: '{{workspace_id}}',
    clientId: '{{client_id}}',
    clientSecret: '{{client_secret}}',
});
const dataPlans = await dataPlanService.getDataPlans();

curl --location --request POST 'https://api.mparticle.com/platform/v2/workspaces/{{workspace_id}}/plans' \
--header 'Authorization: Bearer {{jwt_token}}' \
--data-raw '{
    "data_plan_id": "example_data_plan",
    "data_plan_name": "Mobile Data Plan",
    "data_plan_description": "This is an example data plan description.",
    "data_plan_versions": [
        {
            "version": 1,
            "data_plan_id": "mobile_data_plan",
            "activated_environment": "none",
            "version_document": {
                "data_points": [
                    {
                        "description": "My first data point",
                        "match": {
                            "type": "custom_event",
                            "criteria": {
                                "event_name": "My Custom Event Name",
                                "custom_event_type": "other"
                            }
                        },
                        "validator": {
                            "type": "json_schema",
                            "definition": {
                                "properties": {
                                    "data": {
                                        "additionalProperties": true,
                                        "properties": {
                                            "custom_attributes": {
                                                "additionalProperties": false,
                                                "properties": {
                                                    "foo": {
                                                        "type": "number"
                                                    }
                                                },
                                                "required": [
                                                    "foo"
                                                ]
                                            }
                                        },
                                        "required": [
                                            "custom_attributes"
                                        ]
                                    }
                                }
                            }
                        }
                    }
                ]
            }
        }
    ]
}'

import { DataPlanService } from '@mparticle/data-planning-node';
import { ActivatedEnvironment } from '@mparticle/data-planning-models';

const dataPlanService = new DataPlanService({
    workspaceId: '{{workspace_id}}',
    clientId: '{{client_id}}',
    clientSecret: '{{client_secret}}',
});
const plan = {
    data_plan_id: 'example_data_plan',
    data_plan_name: 'My Example Data Plan',
    data_plan_description: 'This is an example data plan description.',
    data_plan_versions: []
}
const version = {
    version: 1,
    version_description: 'This is an example version description.',
    activated_environment: ActivatedEnvironment.Development,
    version_document: {
        data_points: []
    }
};
const datapoint = {
    description: "My first data point",
    match: {
        type: "custom_event",
        criteria: {
            event_name: "My Custom Event Name",
            custom_event_type: "other"
        }
    },
    validator: {
        type: "json_schema",
        definition: {
            properties: {
                data: {
                    additionalProperties: true,
                    properties: {
                        custom_attributes: {
                            additionalProperties: false,
                            properties: {
                                foo: {
                                    type: "number"
                                }
                            },
                            required: [
                                "foo"
                            ]
                        }
                    },
                    required: [
                        "custom_attributes"
                    ]
                }
            }
        }
    }
};

plan.data_plan_versions.push(version);
version.version_document.data_points.push(datapoint);

const createdPlan = await dataPlanService.createDataPlan(plan)
    .catch(err => {
        console.log(err.status);
        console.log(err.response.data);
    }
);

curl --location --request GET 'https://api.mparticle.com/platform/v2/workspaces/{{workspace_id}}/plans/{{plan_id}}' \
--header 'Authorization: Bearer {{jwt_token}}'

import { DataPlanService } from '@mparticle/data-planning-node';

const dataPlanService = new DataPlanService.DataPlanService({
    workspaceId: '{{workspace_id}}',
    clientId: '{{client_id}}',
    clientSecret: '{{client_secret}}',
});
const dataPlan = await dataPlanService.getDataPlans("example_data_plan_id");

curl --location --request PATCH 'https://api.mparticle.com/platform/v2/workspaces/{{workspace_id}}/plans/{{plan_id}}' \
--header 'Authorization: Bearer {{jwt_token}}' \
--data-raw '{
	"data_plan_description": "This is an updated description..."
}'

import { DataPlanService } from '@mparticle/data-planning-node';

const dataPlanService = new DataPlanService.DataPlanService({
    workspaceId: '{{workspace_id}}',
    clientId: '{{client_id}}',
    clientSecret: '{{client_secret}}',
});
//provide any fields you'd like to update
const updatedPlan = {
    data_plan_description: "This is an updated description"
};
const updatedDataPlan = await dataPlanService.updateDataPlan("example_data_plan", updatedPlan)
    .catch(err => {
        console.log(err.status);
        console.log(err.response.data);
    }
);

curl --location --request DELETE 'https://api.mparticle.com/platform/v2/workspaces/{{workspace_id}}/plans/{{plan_id}}' \
--header 'Authorization: Bearer {{jwt_token}}' \

import { DataPlanService } from '@mparticle/data-planning-node';

const dataPlanService = new DataPlanService({
    workspaceId: '{{workspace_id}}',
    clientId: '{{client_id}}',
    clientSecret: '{{client_secret}}',
});

const deleteDataPlan = await dataPlanService.deleteDataPlan("example_data_plan_id");

curl --location --request POST 'https://api.mparticle.com/platform/v2/workspaces/{{workspace_id}}/plans/{{plan_id}}/versions' \
--header 'Authorization: Bearer {{jwt_token}}' \
--data-raw '{
    "version": 2,
    "version_document": {
        "data_points": [
            {
                "description": "My first data point",
                "match": {
                    "type": "custom_event",
                    "criteria": {
                        "event_name": "My Custom Event Name",
                        "custom_event_type": "other"
                    }
                },
                "validator": {
                    "type": "json_schema",
                    "definition": {
                        "properties": {
                            "data": {
                                "additionalProperties": true,
                                "properties": {
                                    "custom_attributes": {
                                        "additionalProperties": false,
                                        "properties": {
                                            "foo": {
                                                "type": "number"
                                            }
                                        },
                                        "required": ["foo"]
                                    }
                                },
                                "required": [
                                    "custom_attributes"
                                ]
                            }
                        }
                    }
                }
            }
        ]
    },
    "activated_environment": "development"
}'

import { DataPlanService } from '@mparticle/data-planning-node';
import { ActivatedEnvironment } from '@mparticle/data-planning-models';

const dataPlanService = new DataPlanService({
    workspaceId: '{{workspace_id}}',
    clientId: '{{client_id}}',
    clientSecret: '{{client_secret}}',
});

const version = {
    version: 1,
    version_description: 'This is an example version description.',
    activated_environmment: ActivatedEnvironment.Development,
    version_document: {
        data_points: []
    }
};
const datapoint = {
    description: "My first data point",
    match: {
        type: "custom_event",
        criteria: {
            event_name: "My Custom Event Name",
            custom_event_type: "other"
        }
    },
    validator: {
        type: "json_schema",
        definition: {
            properties: {
                data: {
                    additionalProperties: true,
                    properties: {
                        custom_attributes: {
                            additionalProperties: false,
                            properties: {
                                foo: {
                                    type: "number"
                                }
                            },
                            required: [
                                "foo"
                            ]
                        }
                    },
                    required: [
                        "custom_attributes"
                    ]
                }
            }
        }
    }
};

version.version_document.data_points.push(datapoint);

const createdPlanVersion = await dataPlanService.createDataPlanVersion("example_data_plan_id", 2)
    .catch(err => {
        console.log(err.status);
        console.log(err.response.data);
    }
);

curl --location --request GET 'https://api.mparticle.com/platform/v2/workspaces/{{workspace_id}}/plans/{{plan_id}}/versions/{{version}}' \
--header 'Authorization: Bearer {{jwt_token}}'

import { DataPlanService } from '@mparticle/data-planning-node';

const dataPlanService = new DataPlanService.DataPlanService({
    workspaceId: '{{workspace_id}}',
    clientId: '{{client_id}}',
    clientSecret: '{{client_secret}}',
});
const dataPlanVersion = await dataPlanService.getDataPlanVersion("example_data_plan_id", 1)
    .catch(err => {
        console.log(err.status);
        console.log(err.response.data);
    }
);

curl --location --request PATCH 'https://api.mparticle.com/platform/v2/workspaces/{{workspace_id}}/plans/{{plan_id}}/versions/{{version}}' \
--header 'Authorization: Bearer {{jwt_token}}' \
--data-raw '{
    "version": 2,
    "version_document": {
        "data_points": [
            {
                "description": "My first data point, updated",
                "match": {
                    "type": "custom_event",
                    "criteria": {
                        "event_name": "My Custom Event Name",
                        "custom_event_type": "other"
                    }
                },
                "validator": {
                    "type": "json_schema",
                    "definition": {
                        "properties": {
                            "data": {
                                "additionalProperties": true,
                                "properties": {
                                    "custom_attributes": {
                                        "additionalProperties": false,
                                        "properties": {
                                            "foo": {
                                                "type": "number"
                                            }
                                        },
                                        "required": [
                                            "foo"
                                        ]
                                    }
                                },
                                "required": [
                                    "custom_attributes"
                                ]
                            }
                        }
                    }
                }
            }
        ]
    },
    "activated_environment": "development"
}'

const dataPlanService = new DataPlanService.DataPlanService({
    workspaceId: '{{workspace_id}}',
    clientId: '{{client_id}}',
    clientSecret: '{{client_secret}}',
});

const dataPlanVersionUpdate = {
    datapoints: [{
        description: "My first data point",
        match: {
            type: "custom_event",
            criteria: {
                event_name: "My Custom Event Name",
                custom_event_type: "other"
            }
        },
        validator: {
            type: "json_schema",
            definition: {
                properties: {
                    data: {
                        additionalProperties: true,
                        properties: {
                            custom_attributes: {
                                additionalProperties: false,
                                properties: {
                                    foo: {
                                        type: "number"
                                    }
                                },
                                required: [
                                    "foo"
                                ]
                            }
                        },
                        required: [
                            "custom_attributes"
                        ]
                    }
                }
            }
        }
    },
    {
        description: "My second data point",
        match: {
            type: "custom_event",
            criteria: {
                event_name: "My Custom Event Name",
                custom_event_type: "other"
            }
        },
        validator: {
            type: "json_schema",
            definition: {
                properties: {
                    data: {
                        additionalProperties: true,
                        properties: {
                            custom_attributes: {
                                additionalProperties: false,
                                properties: {
                                    foo: {
                                        type: "number"
                                    }
                                },
                                required: [
                                    "foo"
                                ]
                            }
                        },
                        required: [
                            "custom_attributes"
                        ]
                    }
                }
            }
        }
    }]
}
const updatePlanVersion = await dataPlanService.updateDataPlanVersion("example_data_plan_id, 2, dataPlanVersionUpdate)
    .catch(err => {
        console.log(err.status);
        console.log(err.response.data);
    }
);

curl --location --request DELETE 'https://api.mparticle.com/platform/v2/workspaces/{{workspace_id}}/plans/{{plan_id}}/versions/{{version}}' \
--header 'Authorization: Bearer {{jwt_token}}' \

import { DataPlanService } from '@mparticle/data-planning-node';

const dataPlanService = new DataPlanService({
    workspaceId: '{{workspace_id}}',
    clientId: '{{client_id}}',
    clientSecret: '{{client_secret}}',
});

const deleteDataPlanVersion = await dataPlanService.deleteDataPlanVersion("example_data_plan_id", example_version);

curl --location --request POST 'https://api.mparticle.com/platform/v2/workspaces/{{workspace_id}}/plans/validate' \
--header 'Authorization: Bearer {{jwt_token}}' \
--data-raw '{
    "document": {
        "data_points": [
            {
                "match": {
                    "type": "product_impression",
                    "criteria": {}
                },
                "validator": {
                    "type": "json_schema",
                    "definition": {}
                },
                "description": "cupidatat"
            },
            {
                "match": {
                    "type": "custom_event",
                    "criteria": {
                        "event_name": "foo-location",
                        "custom_event_type": "location"
                    }
                },
                "validator": {
                    "type": "json_schema",
                    "definition": {}
                },
                "description": "esse proident officia sint"
            }
        ],
        "transformations": {
            "transformation_id": 70840265.76408121,
            "transformation_name": "sunt veniam esse ipsum",
            "error_pointer": "enim eiusmod dolore in",
            "validation_error_types": [
                "unplanned"
            ],
            "schema_keywords": [
                "additionalProperties"
            ],
            "json_patch": [
                {
                    "op": "remove",
                    "from": "incididunt Ut",
                    "path": "dolor sed officia",
                    "value": "eu Excepteur exercitation esse"
                }
            ],
            "description": "nostrud sunt nulla"
        }
    },
    "batch": {
        "environment": "production",
        "source_request_id": "ut",
        "context": {
            "data_plan": {
                "plan_id": "aliqua",
                "plan_version": 97521295
            }
        },
        "events": [
            {
                "data": {
                    "timestamp_unixtime_ms": 79305770,
                    "source_message_id": "aute nisi",
                    "session_id": 56869342,
                    "session_uuid": "do anim",
                    "session_start_unixtime_ms": -2126166,
                    "event_start_unixtime_ms": 54299226,
                    "custom_attributes": {
                        "dolor__": "incididunt laboris amet elit",
                        "occaecat41f": "velit aliquip minim do"
                    },
                    "location": {
                        "latitude": {}
                    },
                    "device_current_state": {
                    },
                    "is_goal_defined": false,
                    "lifetime_value_change": true,
                    "lifetime_value_attribute_name": "anim mollit dolore",
                    "data_connection_type": "Duis sed sint",
                    "event_num": -85280667,
                    "view_controller": "fugiat irure velit",
                    "is_main_thread": false,
                    "canonical_name": "elit reprehenderit",
                    "event_system_notification_info": {
                        "type": {
                            "value": "<Error: Too many levels of nesting to fake this schema>"
                        }
                    }
                },
                "event_type": "profile"
            },
            {
                "data": {
                    "timestamp_unixtime_ms": -27715666,
                    "source_message_id": "ut commodo",
                    "session_id": 58812755,
                    "session_uuid": "in nisi exercitation",
                    "session_start_unixtime_ms": -74726957,
                    "event_start_unixtime_ms": -99542442,
                    "custom_attributes": {
                        "nisi_0": "occaecat quis Lorem"
                    },
                    "location": {
                    },
                    "device_current_state": {
                    },
                    "is_goal_defined": true,
                    "lifetime_value_change": true,
                    "lifetime_value_attribute_name": "commodo Ut aliqua",
                    "data_connection_type": "id offici",
                    "event_num": 36874422,
                    "view_controller": "veniam",
                    "is_main_thread": false,
                    "canonical_name": "magna est fugiat in",
                    "event_system_notification_info": {
                        "type": {
                            "value": "<Error: Too many levels of nesting to fake this schema>"
                        }
                    }
                },
                "event_type": "screen_view"
            }
        ],
        "device_info": {
        },
        "application_info": {
            "application_name": "est magna ad dolor",
            "application_version": "cillum Excepteur",
            "application_build_number": "magna labore nostrud",
            "install_referrer": "exercit",
            "package": "Ut aliquip fugiat cillum",
            "os": "Unknown",
            "apple_search_ads_attributes": {
                "enim_ee6": {
                    "tempor_db": "sint c",
                    "labore_7d": "non dolore",
                    "in_4b": "nisi id deserunt exe"
                },
                "incididunt289": {
                    "aute_93": "mollit nostrud",
                    "reprehenderitd1": "nulla incididunt adipisicing sint"
                }
            }
        },
        "user_attributes": {
            "fugiatd": {}
        },
        "deleted_user_attributes": [
            "ullamco amet",
            "enim"
        ],
        "user_identities": {
            "other": "non in",
            "customer_id": "non laborum incididunt",
            "facebook": "tempor incididunt velit",
            "twitter": "Lorem velit anim",
            "google": "ad consectetur",
            "microsoft": "do quis pariatur",
            "yahoo": "ex qui",
            "email": "est labore",
            "alias": "ea Excepteur esse incididunt"
        },
        "api_key": "in dolore Ut",
        "api_keys": [
            "culpa labore amet eu",
            "aute in do Ut amet"
        ],
        "ip": "iru",
        "integration_attributes": {
            "cupidatat_7": {
                "cupidatat_7bd": "consectetur"
            },
            "proidentf": {
                "pariatur_4": "offici"
            }
        },
        "partner_identity": "cupidatat aute",
        "source_info": {
            "channel": "native",
            "partner": "id ame",
            "replay_request_id": "sint irure et",
            "replay_job_id": "sed esse",
            "is_historical": false
        },
        "mp_deviceid": "Excepteur dolor",
        "attribution_info": {
            "service_provider": "voluptate minim",
            "publisher": "cill",
            "campaign": "officia cillum esse"
        },
        "timestamp_unixtime_ms": 84190753,
        "batch_id": -72216633,
        "mpid": -724884,
        "sdk_version": "anim cupidatat magna Lorem",
        "consent_state": {
            "gdpr": {
                "regulation": "ut cupidatat",
                "document": "labore in",
                "consented": true,
                "timestamp_unixtime_ms": -70914984,
                "location": "consectetur magna qui incididunt",
                "hardware_id": "non sit"
            }
        },
        "job_id": "sint nulla incididunt do"
    }
}'

import { DataPlanService } from '@mparticle/data-planning-node';

const dataPlanService = new DataPlanService();

// Fetch Data Plan Version asynchronously
const dataPlanVersion = await dataPlanService
    .getVersionDocument(<organizationId>, <accountId>, 'my_custom_data_plan, <workspaceId>, 3, <token>);

const batchValidationResults = dataPlanService.validateBatch(batch, dataPlanVersion.version_document);

const eventValidationResults = dataPlanService.validateEvent(event, dataPlanVersion.version_document);

{
  "results": [
    {
      "data": {
        "match": {
          "type": "product_impression",
          "criteria": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        },
        "validation_errors": [
          {
            "validation_error_type": "unknown",
            "key": "event name or attribute name",
            "error_pointer": "#/data/custom_attributes/foo-attr-1",
            "expected": "null for unplanned entities, the entity name for missing required entities, a data type (e.g. \"number\") for invalid data types, etc",
            "actual": "the entity name for unplanned entities, null for missing required entities, a data type (e.g. \"string\") for invalid data types, etc",
            "action_expected": "drop_batch",
            "schema_keyword": "unevaluatedItems"
          },
          {
            "validation_error_type": "missing_required",
            "key": "event name or attribute name",
            "error_pointer": "#/data/custom_attributes/foo-attr-1",
            "expected": "null for unplanned entities, the entity name for missing required entities, a data type (e.g. \"number\") for invalid data types, etc",
            "actual": "the entity name for unplanned entities, null for missing required entities, a data type (e.g. \"string\") for invalid data types, etc",
            "action_expected": "drop_attribute",
            "schema_keyword": "$ref"
          }
        ],
        "validated_event_id": -86884668.51948906,
        "validated_source_message_id": "nostrud in",
        "executed_transformations": {
          "transformation_id": 97592156.55532053,
          "transformation_status": "failure",
          "transformation_error_type": "events_schema_violated",
          "transformation_error_message": "pariatur enim",
          "transformation_error_pointer": "adipi"
        },
        "timestamp_unixtime_ms": 17037035,
        "event_id": -42247328,
        "source_message_id": "e",
        "session_id": 23278782,
        "session_uuid": "aute fugiat",
        "session_start_unixtime_ms": -6796583,
        "event_start_unixtime_ms": 2872240,
        "custom_attributes": {
          "enimdcc": "dolor veniam ullamco",
          "labore_3": "incididunt cillum"
        },
        "location": {
          "latitude": 31814706.829063505,
          "longitude": 63133216.60368088,
          "accuracy": -11147420.056862295
        },
        "device_current_state": {
          "time_since_start_ms": 40749038,
          "battery_level": -44992792.32572158,
          "data_connection_type": "Lorem fugiat",
          "data_connection_type_detail": "anim cillum cupidatat",
          "gps_state": true,
          "total_system_memory_usage_bytes": -91208220,
          "disk_space_free_bytes": 55999300,
          "external_disk_space_free_bytes": -60627957,
          "cpu": "eu laborum",
          "system_memory_available_bytes": -39377379.67096515,
          "system_memory_low": true,
          "system_memory_threshold_bytes": 57785935.21112856,
          "application_memory_available_bytes": 19617182.87110643,
          "application_memory_max_bytes": -85980007.07383266,
          "application_memory_total_bytes": -59964684.77254946,
          "device_orientation": "portrait",
          "status_bar_orientation": "portrait"
        },
        "is_goal_defined": false,
        "lifetime_value_change": false,
        "lifetime_value_attribute_name": "veniam",
        "data_connection_type": "anim tempor elit",
        "event_num": -33080120,
        "view_controller": "enim aliquip",
        "is_main_thread": true,
        "canonical_name": "enim ea sint",
        "event_system_notification_info": {
          "type": "gdpr_change"
        }
      }
    },
    {
      "data": {
        "match": {
          "type": "user_attributes",
          "criteria": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        },
        "validation_errors": [
          {
            "validation_error_type": "unplanned",
            "key": "event name or attribute name",
            "error_pointer": "#/data/custom_attributes/foo-attr-1",
            "expected": "null for unplanned entities, the entity name for missing required entities, a data type (e.g. \"number\") for invalid data types, etc",
            "actual": "the entity name for unplanned entities, null for missing required entities, a data type (e.g. \"string\") for invalid data types, etc",
            "action_expected": "allow",
            "schema_keyword": "examples"
          }
        ],
        "validated_event_id": -68430764.95735234,
        "validated_source_message_id": "eu velit sit aliqua",
        "executed_transformations": {
          "transformation_id": -33544224.17781522,
          "transformation_status": "unchanged",
          "transformation_error_type": "unrecognized_data_point",
          "transformation_error_message": "Lorem",
          "transformation_error_pointer": "commodo nostrud ut reprehenderit do"
        },
        "timestamp_unixtime_ms": -69435754,
        "event_id": -76370058,
        "source_message_id": "velit sed laborum",
        "session_id": -97492351,
        "session_uuid": "sed",
        "session_start_unixtime_ms": -50784535,
        "event_start_unixtime_ms": 57530189,
        "custom_attributes": {
          "eiusmod_30": "tempor nostrud nisi",
          "dolorccb": "pariatur in",
          "eiusmod94": "culpa exercitation tempor deserunt"
        },
        "location": {
          "latitude": 95229562.92556664,
          "longitude": -96622601.0764705,
          "accuracy": 36701747.652133465
        },
        "device_current_state": {
          "time_since_start_ms": 11072060,
          "battery_level": -84232337.02036467,
          "data_connection_type": "in eiusmod in ex dolore",
          "data_connection_type_detail": "ullamco dolor ex aute occa",
          "gps_state": false,
          "total_system_memory_usage_bytes": 3388989,
          "disk_space_free_bytes": 64499047,
          "external_disk_space_free_bytes": 85198972,
          "cpu": "culpa exerc",
          "system_memory_available_bytes": 10853264.360540748,
          "system_memory_low": false,
          "system_memory_threshold_bytes": 39663588.05889803,
          "application_memory_available_bytes": -18402065.272555396,
          "application_memory_max_bytes": -28878159.212003946,
          "application_memory_total_bytes": 16887590.291536763,
          "device_orientation": "LandscapeLeft",
          "status_bar_orientation": "landscape"
        },
        "is_goal_defined": false,
        "lifetime_value_change": false,
        "lifetime_value_attribute_name": "adipisicing veniam",
        "data_connection_type": "enim",
        "event_num": -93170864,
        "view_controller": "irure ipsum ullamco",
        "is_main_thread": false,
        "canonical_name": "velit consectetur",
        "event_system_notification_info": {
          "type": "gdpr_change"
        }
      }
    }
  ],
  "batch": {}
}

results: [
    {
        data: {
            match: {
                type: 'screen_view',
                criteria: {
                    screen_name: 'Test Screen View',
                },
            },
            validation_errors: [
                {
                    error_pointer: '#/data',
                    key: 'data',
                    expected: 'custom_flags',
                    schema_keyword: 'required',
                    validation_error_type: 'missing_required',
                },
            ],
        },
        event_type: 'validation_result',
    },
],