Docs
DevelopersIntegrationsGuides

Developers

Platform API

The mParticle platform API allows you to RESTfully create and update a number of entities such as Apps, App Platforms, as well as configure services to forward data to.

Endpoint

The platform API is located at https://api.mparticle.com.

Prerequisites to Accessing the API

Before you can authenticate to the Platform API you must first contact your account representative or email our support desk to arrange for a Client ID and Secret to access the Token API. You will need to provide a PGP public key for secure transmission of your credentials. You can then use the ID and secret to fetch an oauth access token.

Authentication

Once your API user is set up, you can authenticate by issuing a POST request to mParticle’s SSO token endpoint.

https://sso.auth.mparticle.com/oauth/token

The JSON body of the request must contain:

  • client_id - your Client ID, issued by mParticle
  • client_secret - your Client Secret, issued by mParticle
  • audience - set to a value of "https://api.mparticle.com"
  • grant_type - set to a value of "client_credentials"

Curl Syntax

curl --request POST \
  --url https://sso.auth.mparticle.com/oauth/token \
  --header 'content-type: application/json' \
  --data '{"client_id":"...","client_secret":"...","audience":"https://api.mparticle.com","grant_type":"client_credentials"}'

Sample Raw HTTP Request

POST /oauth/token HTTP/1.1
Host: sso.auth.mparticle.com
Content-Type: application/json

{
  "client_id": "your_client_id",
  "client_secret": "your_client_secret",
  "audience": "https://api.mparticle.com",
  "grant_type": "client_credentials"
}

Using your Bearer Token

A successful POST request to the token endpoint will result in a JSON response as follows:

{
  "access_token": "YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-",
  "expires_in" : 86400,
  "token_type": "Bearer"
}

Subsequent requests to the API can now be authorized by setting the Authorization header as follows:

Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-

Tokens cannot be revoked, but will expire every 24 hours. The initial token request can take between 1 and 3 seconds, so it is recommended that you cache the token and refresh it only when necessary.

Versioning

Once you have authenticated, the API resources can be accessed at https://api.mparticle.com/v1/. Subsequent updates to the API that introduce breaking changes will be published with a new version number in the URL.

API Usage

Specifying your Account ID

All API calls require you to pass AccountId as a querystring parameter when making the request, with the exception of a GET /accounts which lists all accounts. Forgetting to add the AccountId parameter when required will result in a 401 Unauthorized response.

If you are unsure what your Account ID is, you can make a GET request to https://api.mparticle.com/v1/accounts . This will return a list of Accounts within your Organization, and from there you can choose an Account ID to work with. All subsequent entities that you work with will be within the scope of the chosen Account ID. Attempting to access or modify entities outside of the specified Account ID scope will return 404 - Not Found.

Sending Data

All POST/PUT requests should send JSON as the Request Payload, with Content-Type set to application/json.

Return Data

If an API request returns data, it will be wrapped in a common JSON structure.

{
  "data": [],
  "dataType": "app",
  "errors": [
    {
        "code": "VALIDATION_ERROR",
        "message": "Error message here"
    }
  ]
}

One or more entities will be returned as an array in the data property. If errors were encountered, they will be available as an array of error objects.

Status Codes

The following table lists the status codes that are returned by API requests:

Statis Code Method Notes
200 OK GET
201 Created POST
202 Accepted PUT
204 No Content DELETE
400 Bad Request All JSON Syntax is invalid.
401 Unauthorized All User failed authentication.
403 Forbidden All Identity is not authorized to invoke specified method.
404 Not Found GET Resource does not exist or user does not have access.
405 Method Not Allowed All Specified HTTP method not supported.
422 Unprocessable Entity PUT/POST/DELETE Request failed business logic rules.
500 Internal Server Error All Contact mParticle support to resolve this error.

Cross Origin Resource Sharing

The mParticle REST API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin.

REST Resources

Accounts

Get a Single Account

GET /accounts/1?accountId=1

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi341GHhnDnjsdKAJQxNjdjYuOJABbg6HdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/accounts/1?accountId=1"
Example Response
{
  "data": [
    {
      "name": "My Account",
      "last_modified_on": "2014-11-14T22:46:38.673",
      "data_type": "account",
      "id": 1,
      "created_on": "2013-07-23T18:49:38.547"
    }
  ],
  "dataType": "account",
  "errors": null
}

Get All Accounts

GET /accounts

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi341GHhnDnjsdKAJQxNjdjYuOJABbg6HdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/accounts ?accountId=1"
Example Response
{
  "data": [
    {
      "name": "My Account",
      "last_modified_on": "2014-11-14T22:46:38.673",
      "data_type": "account",
      "id": 1,
      "created_on": "2013-07-23T18:49:38.547"
    }
  ],
  "dataType": "account",
  "errors": null
}

Update an account

PUT /accounts/1?accountId=1

curl \
  -X PUT \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  -H "Content-Type: application/json" \
  -d "{\"name\": \"Updated Name\"}" \
  "https://api.mparticle.com/v1/accounts/1?accountId=1" \
Parameters
Name Type Description
name string The display name of the account.
Errors
Name
Account name is not unique.

Create an account

POST /accounts

curl 
  -X POST \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  -H "Content-Type: application/json" \
  -d "{\"name\": \"New Account\"}" \
  "https://api.mparticle.com/v1/accounts"
Parameters
Name Type Description
name string The display name of the account.

Delete an account

DELETE /accounts

curl -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" -H "Content-Type: application/json" -X DELETE https://api.mparticle.com/v1/accounts?accountId=1
Errors
Name
All applications must be deleted before deleting account.

Apps

Get a single app

GET /apps/1?accountId=1

curl -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" -X GET https://api.mparticle.com/v1/apps/1?accountId=1
Example Response
{
  "data": [
    {
      "name": "Test App",
      "platforms": [
        {
          "application_id": 1,
          "os": "Android",
          "access_keys": [
            {
              "key": "AccessKey",
              "secret": null,
              "data_type": "token"
            }
          ],
          "crash_handling": "AppDefined",
          "network_performance": "AppDefined",
          "social_mode": "AppDefined",
          "profile_merging": false,
          "push_attribution_timer": 30,
          "last_modified_on": "2014-11-05T20:09:46.577",
          "data_type": "platform",
          "created_on": "2014-06-11T19:43:48.697"
        }
      ],
      "last_modified_on": "2014-06-11T19:43:45.617",
      "data_type": "application",
      "id": 1,
      "created_on": "2014-06-11T19:43:45.617"
    }
  ],
  "dataType": "application",
  "errors": null
}

Get all apps

GET /apps?accountId=1

curl -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" -X GET https://api.mparticle.com/v1/apps?accountId=1
Example Response
{
  "data": [
    {
      "name": "Test App",
      "platforms": [
        {
          "application_id": 1,
          "os": "Android",
          "access_keys": [
            {
              "key": "AccessKey",
              "secret": null,
              "data_type": "token"
            }
          ],
          "crash_handling": "AppDefined",
          "network_performance": "AppDefined",
          "social_mode": "AppDefined",
          "profile_merging": false,
          "push_attribution_timer": 30,
          "last_modified_on": "2014-11-05T20:09:46.577",
          "data_type": "platform",
          "created_on": "2014-06-11T19:43:48.697"
        }
      ],
      "last_modified_on": "2014-06-11T19:43:45.617",
      "data_type": "application",
      "id": 1,
      "created_on": "2014-06-11T19:43:45.617"
    }
  ],
  "dataType": "application",
  "errors": null
}

Update an app

PUT /apps/1?accountId=1

curl \
  -X PUT \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  -H "Content-Type: application/json"  \
  -d "{\"name\": \"Updated Name\"}" \
  "https://api.mparticle.com/v1/apps/1?accountId=1"
Example Request
{
  "name": "Test App New Name"
}
Parameters
Name Type Description
name string The name of the app.
Errors
Name
App name must be specified.

Create an app

POST /apps?accountId=1

curl \
  -X POST \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  -H "Content-Type: application/json" \
  -d "{\"name\": \"Updated Name\", \"platforms\":[{\"os\": \"iOS\"},{\"os\": \"Android\"}]}" \
  "https://api.mparticle.com/v1/apps/1?accountId=1"
Example Request
{
  "name": "Test App",
  "platforms": [
    {
      "os": "iOS"
    },
    {
      "os": "Android"
    }
  ]
}
Example Response
{
  "data": [
    {
      "name": "Test App",
      "platforms": [
        {
          "application_id": 1,
          "os": "iOS",
          "access_keys": [
            {
              "key": "AccessKey",
              "secret": "AccessSecret",
              "data_type": "token"
            }
          ],
          "crash_handling": null,
          "network_performance": null,
          "social_mode": null,
          "profile_merging": true,
          "push_attribution_timer": 30,
          "last_modified_on": "2015-03-11T12:07:08.077",
          "data_type": "platform",
          "created_on": "2015-03-11T12:07:08.077"
        }
      ],
      "last_modified_on": "2015-03-11T12:07:07.877",
      "data_type": "application",
      "id": 1,
      "created_on": "2015-03-11T12:07:07.877"
    }
  ],
  "dataType": "application",
  "errors": null
}
Parameters
Name Type Description
name string The name of the app
platforms array Array of platforms to create for the app in the format of {"os": "iOS"}. Valid values for the “os” field include “iOS”, “tvOS”, “Android”, “MobileWeb”, “Roku”, “Alexa”, “SmartTV”, “FireTV”, and “Xbox”
Errors
Name
Exceeded app limit.
App name already exists.
App must have at least one platform selected.
App name not specified.
Invalid as specified.
Notes

Creating a new app or app platform will generate a new Access Key and Secret for that app platform, which can be accessed through the “access_keys”. Note that this is the only time the Secret is transmitted - subsequent GET requests will only return the Access Key.

Delete an app

DELETE /apps/1?accountId=1

curl \
  -X DELETE \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-"  \
  https://api.mparticle.com/v1/apps/1?accountId=1
Errors
Name
Deleting an app that has active platforms is not allowed.

App Platforms

Get a single app platform

GET /apps/1/platforms/android?accountId=1

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/apps/1/platforms/android?accountId=1" \
Example Response
{
  "data": [
    {
      "application_id": 1,
      "os": "Android",
      "access_keys": [
        {
          "key": "AccessKey",
          "secret": null,
          "data_type": "token"
        }
      ],
      "crash_handling": "AppDefined",
      "network_performance": "AppDefined",
      "social_mode": "AppDefined",
      "profile_merging": false,
      "push_attribution_timer": 30,
      "last_modified_on": "2014-11-05T20:09:46.577",
      "data_type": "platform",
      "created_on": "2014-06-11T19:43:48.697"
    }
  ],
  "dataType": "platform",
  "errors": null
}

Get all app platforms

GET /apps/1/platforms?accountId=1

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/apps/1/platforms?accountId=1"
Example Response
{
  "data": [
    {
      "application_id": 1,
      "os": "Android",
      "access_keys": [
        {
          "key": "AccessKey",
          "secret": null,
          "data_type": "token"
        }
      ],
      "crash_handling": "AppDefined",
      "network_performance": "AppDefined",
      "social_mode": "AppDefined",
      "profile_merging": false,
      "push_attribution_timer": 30,
      "last_modified_on": "2014-11-05T20:09:46.577",
      "data_type": "platform",
      "created_on": "2014-06-11T19:43:48.697"
    }
  ],
  "dataType": "platform",
  "errors": null
}

Update an app platform

PUT /apps/1/platforms/ios?accountId=1

curl \
  -X PUT \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  -H "Content-Type: application/json" \
  -d "{\"profile_merging\": true,\"push_attribution_timer\": 30,\"crash_handling\": \"ForceCatch\",\"network_performance\": \"ForceTrue\",\"social_mode\": \"FacebookAndTwitter\"}" \
  "https://api.mparticle.com/v1/apps/1/platforms/ios?accountId=1"
Example Request Body
{
  "profile_merging": true,
  "push_attribution_timer": 30,
  "crash_handling": "ForceCatch",
  "network_performance": "ForceTrue",
  "social_mode": "FacebookAndTwitter"
}
Parameters
Name Type Description
profile_merging bool Enable or disable profile merging
push_attribution_timer int Push attribution timer in minutes
crash_handling string “AppDefined” or “ForceCatch” or “ForceIgnore”
network_performance string “AppDefined” or “ForceTrue” or “ForceFalse”
social_mode string “AppDefined” or “Facebook” or “Twitter” or “FacebookAndTwitter”

Create an app platform

POST /apps/1?accountId=1

curl \
  -X POST \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  -H "Content-Type: application/json" \
  -d "{\"os\": \"android\",\"profile_merging\": true,\"push_attribution_timer\": 30,\"crash_handling\": \"ForceCatch\",\"network_performance\": \"ForceTrue\",\"social_mode\": \"FacebookAndTwitter\"}" \
  "https://api.mparticle.com/v1/apps/1?accountId=1"
Example Request
{
  "os": "android",
  "profile_merging": true,
  "push_attribution_timer": 30,
  "crash_handling": "ForceCatch",
  "network_performance": "ForceTrue",
  "social_mode": "FacebookAndTwitter"
}
Example Response
{
  "data": [
    {
      "application_id": 1,
      "os": "Android",
      "access_keys": [
        {
          "key": "AccessKey",
          "secret": "AccessSecret",
          "data_type": "token"
        }
      ],
      "crash_handling": "AppDefined",
      "network_performance": "AppDefined",
      "social_mode": "AppDefined",
      "profile_merging": false,
      "push_attribution_timer": 30,
      "last_modified_on": "2014-11-05T20:09:46.577",
      "data_type": "platform",
      "created_on": "2014-06-11T19:43:48.697"
    }
  ],
  "dataType": "platform",
  "errors": null
}
Parameters
Name Type Description
os string Valid values for the “os” field include “iOS”, “tvOS”, “Android”, “MobileWeb”, “Roku”, “Alexa”, “SmartTV”, “FireTV”, and “Xbox”
profile_merging bool Enable or disable profile merging
push_attribution_timer int Push attribution timer in minutes
crash_handling string “AppDefined” or “ForceCatch” or “ForceIgnore”
network_performance string “AppDefined” or “ForceTrue” or “ForceFalse”
social_mode string “AppDefined” or “Facebook” or “Twitter” or “FacebookAndTwitter”
Errors
Name
Could not create platform: App does not exist or you do not have access.
Invalid os specified.
Platform already exists for the specified App.
Notes

Creating a new app or app platform will generate a new Access Key and Secret for that app platform, which can be accessed through the “access_keys”. Note that this is the only time the Secret is transmitted - subsequent GET requests will only return the Access Key.

Delete an app platform

DELETE /apps/1/platforms/ios?accountId=1

curl \
  -X DELETE \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/apps/1/platforms/ios?accountId=1"

App Platform Services

Get all services for an app platform

GET /apps/1/platforms/ios/services?accountId=1

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/apps/1/platforms/ios/services?accountId=1`"
Example Response
{
  "data": [
    {
      "account": "Default Account",
      "name": "GoogleAnalyticsEventForwarder",
      "isActive": true,
      "isVisible": true,
      "settings": [
        {
          "name": "apiKey",
          "value": "*********** Key",
          "isConfidential": true
        }
      ],
      "data_type": "service"
    }
  ],
  "dataType": "service",
  "errors": null
}

Configure a service for an app platform

PUT /apps/1/platforms/ios/services?accountId=1

curl \
  -X PUT \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  -H "Content-Type: application/json" \
  -d "{\"account\": \"Default Account\", \"name\":\"GoogleAnalyticsEventForwarder\",\"isActive\":true,\"isVisible\": true,\"settings\":[{\"name\":\"apiKey\",\"value\":\"My Test App Key\"}]}" \
  "https://api.mparticle.com/v1/apps/1/platforms/ios/services?accountId=1"
Example Request
{
  "account": "Default Account",
  "name":"GoogleAnalyticsEventForwarder",
  "isActive":true,
  "isVisible": true,
  "settings":[
    {
      "name":"apiKey",
      "value":"My Test App Key"
    }
  ]
}
Parameters
Name Type Description
account string The name of the account you wish to configure.
name string The name of the service you wish to configure
isActive bool Controls whether data is actually pushed to the service
isVisible bool Whether the service is visible in the UI
settings array Array of setting objects
Errors
Name
Specified service not found.
Service does not support app platform.
Invalid settings entered while updating the service.
Provided setting not found.
Required setting not provided.
Setting value is required.
Notes

To discover what settings are available for each service, you can call https://api.mparticle.com/v1/services?accountId=1 to discover all services and supported settings.

The “account” parameter allows you to forward data to more than one account per service. It is internal to mParticle, and can be set to any name of your choosing. If omitted or set to null, the account name will be set to “Default Account”.

The “isVisible” flag allows you to create services that forward data in the background, but are not visible in the mParticle UI. This allows you to have two active forwarders per combination of app platform and service. This field is not required and will default to true if omitted.

Audiences

Get All Audiences for an Account

GET /audiences?accountId=1

This request returns an array containing all active single and multiple workspace audiences for an account. Details for each audience include:

  • name / external_name - The names for the audience shown within the mParticle dashboard and to external platforms.
  • id - the unique mParticle identifier for the audience.
  • is_calculated - true if boolean logic is used to build the audience.
  • connected_outputs - A list of each output platform the audience is currently connected to.
curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/audiences?accountId=1"
Example Response
[
    {
        "name": "Abandoned Cart",
        "external_name": "Abandoned Cart",
        "size": 342,
        "created_by": "jsmith",
        "last_modified_by": "mmann",
        "last_modified_on": "2017-01-12T17:27:34.387",
        "is_calculated": false,
        "added_last_24_hours": 10,
        "dropped_last_24_hours": 7,
        "status": "active",
        "connected_outputs": [
            {
                "provider_name": "Mixpanel",
                "configurations": [
                {
                    "name": "Prod"
                }
                ],
                "data_type": "audience_output"
            },
            {
                "provider_name": "ActionX",
                "configurations": [
                {
                    "name": "Dev"
                }
                ],
                "data_type": "audience_output"
            }
        ],
        "data_type": "audience",
        "id": 7622
    }
]

Delete an Audience

DELETE /audiences/<audience_id>?accountId=1

Deletes an audience. The Audience ID is a 4 digit number available as the "id" node in the Get All Audiences for an Account response.

curl \
  -X DELETE \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/audiences/7239?accountId=1"

Users

Get all users

GET /users?accountId=1

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/users?accountId=1"
Example Response
{
  "data": [
    {
      "first_name": "Test",
      "last_name": "User",
      "email": "testuser@mparticle.com",
      "data_type": "user"
    }
  ],
  "dataType": "user",
  "errors": null
}

Get a specific user

GET /users/test40mparticle2Ecom?accountId=1

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/users/test40mparticle2Ecom?accountId=1"
Example Response
{
  "data": [
    {
      "first_name": "Test",
      "last_name": "User",
      "email": "test@mparticle.com",
      "data_type": "user"
    }
  ],
  "dataType": "user",
  "errors": null
}

Services

When getting service information, both configuration and connection settings are returned. Refer to the Custom Service Settings for specifying these settings.

Get all services available for an account

GET /services?accountId=1

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/services?accountId=1"
Example Response
{
  "data": [
    {
      "name": "ActionX",
      "settings": [
        {
          "is_required": true,
          "name": "advertiserToken",
          "description": "The ActionX Advertiser Token for your app.",
          "type": "String"
        },
        {
          "is_required": false,
          "name": "useCustomerId",
          "description": "If enabled, mParticle will forward your Customer ID values to ActionX.",
          "type": "Bool"
        }
      ],
      "data_type": "service"
    }
  ],
  "dataType": "service",
  "errors": null
}

Get a specific service with settings

GET /services/Amplitude?accountId=1

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/services/Amplitude?accountId=1"
Example Response
{
  "data": [
    {
      "name": "Amplitude",
      "settings": [
        {
          "is_required": true,
          "name": "apiKey",
          "description": "Your app's Amplitude API Key.  You can find this on the \"My Account\" page of Amplitude's dashboard.",
          "type": "String"
        },
        {
          "is_required": true,
          "name": "userIdentification",
          "description": "To identify users, choose \"Customer ID\" to send Customer ID if provided or or \"Email\" to send Email addresses if provided.",
          "type": "String"
        },
        {
          "is_required": false,
          "name": "includeEmailAsUserProperty",
          "description": "If true, a hashed Customer ID, when available, will be forwarded as User ID",
          "type": "Bool"
        }
      ],
      "data_type": "service"
    }
  ],
  "dataType": "service",
  "errors": null
}

DataPoints

A DataPoint represents a unique data item that has been detected by our system. A DataPoint can be created by calling methods on our SDK such as logEvent, or they can be created using the Events API. Examples of DataPoints are Screen Views, Purchase Events, Navigation Events and Search events among others. All DataPoints are specific to a particular App.

Get DataPoints for an App

GET /apps/1/datapoints

Retrieves a list of DataPoints that exist for an App.

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/apps/1/datapoints?accountId=1"
Example Response
{
  "data": [
    {
      "name": "my event",
      "attribute_name": null,
      "type": "Event",
      "event_type": "navigation",
      "data_type": "datapoint",
      "created_on": "2015-06-04T18:11:06.027"
    },
    {
      "name": "my event",
      "attribute_name": "my event attribute",
      "type": "EventAttribute",
      "event_type": "navigation",
      "data_type": "datapoint",
      "created_on": "2015-06-04T18:53:23.25"
    },
    {
      "name": "my screen view",
      "attribute_name": null,
      "type": "ScreenView",
      "event_type": null,
      "data_type": "datapoint",
      "created_on": "2015-06-04T18:53:23.25"
    },
    {
      "name": "my screen view",
      "attribute_name": "my screen view attribute",
      "type": "ScreenViewAttribute",
      "event_type": null,
      "data_type": "datapoint",
      "created_on": "2015-06-04T18:53:23.25"
    }
  ],
  "dataType": "datapoint",
  "errors": null
}
Supported DataPoint Types
Name Description
Event A standard app event.
EventAttribute An attribute of an app event.
UserAttribute A user attribute.
ScreenView A screen view.
ScreenViewAttribute An attribute of a screen view.
Identity A user identity type.
Commerce A commerce event.
CommerceAttribute An attribute of a commerce event.
Supported DataPoint Event Types

If a DataPoint is of type “Event” or “EventAttribute”, then the EventType field will be populated with one of the following values:

Name Description
unknown Unknown Event.
navigation Navigation Event.
location Location Event.
search Search Event.
transaction Transaction Event.
user_content User Content Event.
user_preference User Preference Event.
social Social Event.
other Other Event.
media Media Event.

If a DataPoint is of type Commerce or CommerceAttribute, then the EventType field will be populated with one of the following values:

Name Description
product_add_to_cart Add to Cart Event.
product_remove_from_cart Remove from Cart Event.
product_checkout Checkout Event.
product_checkout_option Checkout Option Event.
product_click Click Event.
product_view_detail View Detail Event.
product_purchase Purchase Event.
product_refund Refund Event.
promotion_view Promotion View Event.
promotion_click Promotion Click Event.

Add DataPoint

PUT /apps/1/datapoints

Adds a new DataPoint for an App.

curl \
  -X PUT \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  -H "Content-Type: application/json" \
  -d "{\"name\":\"my event\",\"type\":"event",\"event_type\": "navigation"}" \
  "https://api.mparticle.com/v1/apps/1/datapoints?accountId=1"
Example Request
[
  {
    "name": "my event",
    "type": "event",
    "event_type": "navigation"
  }
]
Parameters

Accepts an array of DataPoint objects, which have the following properties:

Name Type Description
name string The name of the DataPoint.
attribute_name string An attribute name (optional).
type enum The type of DataPoint.
event_type enum Can only be set if DataPoint type is “Event”, “EventAttribute”, “Commerce” or “CommerceAttribute”.
Supported DataPoint Types

The “type” field can be set to one of the following values:

Name Description
Event A standard app event.
EventAttribute An attribute of an app event.
UserAttribute A user attribute.
ScreenView A screen view.
ScreenViewAttribute An attribute of a screen view.
Identity A user identity type.
Commerce A commerce event.
CommerceAttribute An attribute of a commerce event.
Supported Event Types

The “event_type” field can be set to one of the following values. This field is only required when the “type” is set to “Event” or “EventAttribute”.

Name Description
unknown Unknown Event.
navigation Navigation Event.
location Location Event.
search Search Event.
transaction Transaction Event.
user_content User Content Event.
user_preference User Preference Event.
social Social Event.
other Other Event.
media Media Event.
Notes

You can add new DataPoints for an App using the API. DataPoints are automatically detected when data is received from your App, however it may be more convenient to insert this data using the API in advance, rather than waiting until your App is fully instrumented using the mParticle SDK. This will allow you to configure features such as Data Filtering without having to wait for App instrumentation to be completed.

DataPoint Filters

Get Service Filtering

GET /apps/1/GoogleAnalyticsEventForwarder?accountId=1

Get default filtering behavior for a service.

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/apps/1/GoogleAnalyticsEventForwarder?accountId=1"
Example Response
{
  "data": [
    {
      "name": "GoogleAnalyticsEventForwarder",
      "sendNewDataPointsByDefault": true
    }
  ],
  "dataType": "datapoint",
  "errors": null
}
Notes

This call shows any filtering configuration that exists at the Service level. Currently, this is just one property, "sendNewDataPointsByDefault", which controls whether newly detected DataPoints are sent to this Service by default.

Update Service Filtering

PUT /apps/1/GoogleAnalyticsEventForwarder?accountId=1

curl \
  -X PUT \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  -H "Content-Type: application/json" \
  -d "{\"sendNewDataPointsByDefault\":false}" \
  "https://api.mparticle.com/v1/apps/1/GoogleAnalyticsEventForwarder/datapoints?accountId=1"
Example Request
{
  "sendNewDataPointsByDefault": false
}
Parameters
Name Type Description
sendNewDataPointsByDefault bool Controls whether newly detected DataPoints are sent to this service by default.
Notes

Setting "sendNewDataPointsByDefault" to false will prevent newly detected DataPoints from being sent to the specified Service. Any existing DataPoints will not be affected, and will continue to be sent or filtered based on the existing configuration.

Get DataPoint Filters

GET /apps/1/GoogleAnalyticsEventForwarder/datapoints?accountId=1

Retrieve a list of DataPoint filters for a specific App and Service.

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/apps/1/GoogleAnalyticsEventForwarder/datapoints?accountId=1"
Example Response
{
  "data": [
    {
      "name": "my event",
      "attribute_name": null,
      "type": "Event",
      "event_type": "navigation",
      "enabled": true,
      "data_type": "datapoint",
      "created_on": "2015-06-04T18:11:06.027"
    },
    {
      "name": "my event",
      "attribute_name": "my event attribute",
      "type": "EventAttribute",
      "enabled": false,
      "event_type": "navigation",
      "data_type": "datapoint",
      "created_on": "2015-06-04T18:53:23.25"
    }
  ],
  "dataType": "datapoint",
  "errors": null
}
Notes

Note that this list of DataPoints are filtered by types that are supported by the service. If the service does not support the ScreenView DataPoint for example, then this DataPoint will not appear in the list.

The DataPoint types "EventAttribute", "ScreenViewAttribute", and "CommerceAttribute" are child DataPoints that have a parent DataPoint. In these cases, "attribute_name" will contain the name of the attribute, and "name" will contain the name of the parent.

Update DataPoint Filters

PUT /apps/1/GoogleAnalyticsEventForwarder/datapoints?accountId=1

curl 
  -X PUT 
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" 
  -H "Content-Type: application/json" 
  -d "[{\"name\":\"my event\", \"type\":\"event\", \"event_type\": \"navigation\", \"enabled\": true},{\"name\": \"my event\",\"attribute_name\": \"my event attribute\",\"event_type\": \"navigation\",\"type\": \"eventattribute\",\"enabled\": false}]" 
  "https://api.mparticle.com/v1/apps/1/GoogleAnalyticsEventForwarder/datapoints?accountId=1"
Example Response
[
  {
    "name": "my event",
    "type": "Event",
    "event_type": "navigation",
    "enabled": true
  },
  {
    "name": "my event",
    "attribute_name": "my event attribute",
    "type": "EventAttribute",
    "event_type": "navigation",
    "enabled": false
  }
]
Parameters

Accepts an array of DataPoint Filter objects, which have the following properties:

Name Type Description
name string The name of the DataPoint.
attribute_name string An attribute name (optional).
type enum The type of DataPoint.
event_type enum Can only be set if DataPoint type is “Event”, “EventAttribute”, “Commerce” or “CommerceAttribute”.
enabled bool Set to false to prevent this DataPoint from being sent to this service.
Supported DataPoint Filter Types

The "type" field can be set to one of the following values:

Name Description
Event A standard app event.
EventAttribute An attribute of an app event.
UserAttribute A user attribute.
EventType Filter all app events of a particular type.
ScreenView A screen view.
ScreenViewAttribute An attribute of a screen view.
UserIdentity A user identity type.
Commerce A commerce event.
CommerceAttribute An attribute of a commerce event.
Supported User Identity Types

If the "type" is set to "UserIdentity", then the "name" field should be set to one of the following allowed values:

Name Description
CustomerId Customer Id.
Facebook Facebook Id.
Twitter Twitter Handle.
Google Google Id.
Microsoft Microsoft Id.
Yahoo Yahoo Id.
Email Email Address.
Other Other.
Supported Event Types

If the "type" is set to "Event" or "EventAttribute", the "event_type" field can be set to one of the following values. If "type" is set to "EventType", then the "name" field should be set to one of the values below:

Name Description
unknown Unknown Event.
navigation Navigation Event.
location Location Event.
search Search Event.
transaction Transaction Event.
user_content User Content Event.
user_preference User Preference Event.
social Social Event.
other Other Event.
media Media Event.

If the "type" is set to "Commerce" or "CommerceAttribute", the "event_type" field can be set to one of the following values:

Name Description
product_add_to_cart Add to Cart Event.
product_remove_from_cart Remove from Cart Event.
product_checkout Checkout Event.
product_checkout_option Checkout Option Event.
product_click Click Event.
product_view_detail View Detail Event.
product_purchase Purchase Event.
product_refund Refund Event.
promotion_view Promotion View Event.
promotion_click Promotion Click Event.
Notes

When configuring DataPoints of type "EventAttribute" or "ScreenViewAttribute" or "CommerceAttribute", you must include the name of the attribute in "attribute_name", and the name of the parent DataPoint in "name".

When configuring DataPoints of type "Event" or "EventAttribute", you must set the "event_type" field. Failure to do so will cause an error to occur. The "event_type" field is ignored for other types of DataPoints other than “Event” and "EventAttribute".

If the DataPoint specified does not exist, it will be created automatically. Please note that to avoid creating duplicate DataPoints unintentionally, "type", "name", "attribute_name" and "event_type" should all be set correctly.

Due to the hierarchical nature of DataPoints, disabling some types of DataPoints will cause child DataPoints to also become disabled automatically. For example, turning off EventType "Navigation" will cause all Events and EventAttributes of that Event Type to become disabled. Turning off an Event will cause all child Event Attributes to become disabled.

Custom Service Settings

Google Analytics Settings

Google Analytics has a few configuration settings which require additional details to be set. These settings are listed below are are noted with a type of Custom in the services call.:

  1. customDimensions
  2. customMetrics
Example
{
  "account": "Default Account",
  "name":"GoogleAnalyticsEventForwarder",
  "isActive":true,
  "isVisible": true,
  "settings":[
    {
      "name":"apiKey",
      "value":"My Test App Key"
    }
    {
      "name":"customDimensions",
      "value":"[{\"maptype\":\"EventAttributeClass.Name\",\"map\":\"Bitcoins\",\"value\":\"Dimension 3\"}]"
    }
  ]
}

Check Google Analytics for additional details on these settings and the limits on the supported custom dimensions and metrics. The value for these settings is a json array containing objects with maptype, map and value. You need to indicate if you are using an Event Attribute or a User Attribute, and then specify the mapping to the Custom Dimension or Custom Metric.

Field Description Notes - examples
maptype This indicates if you are passing an event or user attribute into the map. EventAttributeClass.Name or UserAttributeClass.Name or ProductAttributeClass.Name.
map The name of the event attribute, user attribute or product attribute. The attribute name must match exactly or it will not map correctly. For example, Bitcoins.
value The custom dimension or custom metric for the mapping. For example, Dimension 3 or Metric 1

Feeds

Get list of partner feeds for a workspace

GET /workspace/<partnerfeedId>/partnerfeeds?accountId=1

Returns a list of partner feeds set up for a workspace. 

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/workspace/1/partnerfeeds?accountId=1`"
Example Response
{
  "data": [
    {
      "id": "4302",
      "name": "SFMC Feed",
      "data_type": "partner_feed",
      "created_on": "2019-04-05T10:40:23"
    }
  ],
  "dataType": "partner_feed",
  "errors": null
}

Get Feed

GET /partnerfeeds/<feed-id>?accountId=1

Get details and settings for a specific partner feed.

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/partnerfeeds/229?accountId=1`"
Example Response
{
    "data": [
        {
            "module_name": "MailChimp",
            "name": "Mailchimp1",
            "os": "Unknown",
            "is_debug": false,
            "settings": [
                {
                    "value": null,
                    "name": "apiKey"
                },
                {
                    "value": null,
                    "name": "listId"
                },
                {
                    "value": "html",
                    "name": "emailType"
                },
                {
                    "value": "True",
                    "name": "doubleOptIn"
                },
                {
                    "value": "False",
                    "name": "deleteMemberOnUnsubscribe"
                },
                {
                    "value": "True",
                    "name": "deleteMemberAtSubscriptionEnd"
                }
            ],
            "data_type": "Partner Feed",
            "id": 229
        }
    ],
    "data_type": "Partner Feed",
    "errors": null
}

Create Feed

POST /workspace/<workspace-id>/partnerfeeds?accountId=1

Creates a new feed.

Field Description Notes - examples
module_name Name of the feed module radar
name A unique name for the feed configuration. radariOSFeed
os Platform the feed should act as. iOS, tvOS, Android, MobileWeb, Roku, Alexa, SmartTV, FireTV, Xbox, Unknown
settings Array of objects for each feed setting. Each object should have a name and value. Not all feeds have settings. 
curl \
  -X POST \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  -H "Content-Type: application/json" \
  -d "{ \
    \"module_name\": \"radar\", \
    \"name\": \"radariOSFeed\", \
    \"os\": \"ios\", \
    \"settings\": [], \
    \"is_debug\": true \
  }" \
  "https://api.mparticle.com/v1/workspace/1/partnerfeeds?accountId=1"
Example Response
{
    "data": [
        {
            "data_type": "Partner Feed",
            "id": 689,
            "created_on": "2019-07-16T20:46:45.25"
        }
    ],
    "data_type": "Partner Feed",
    "errors": null
}

Update Feed

PUT /workspace/<workspace-id>/partnerfeeds/<feed-id>?accountId=1

Updates an existing feed.

Field Description Notes - examples
module_name Name of the feed module. radar
name A unique name for the feed configuration. radariOSFeed
os Platform the feed should act as. iOS, tvOS, Android, MobileWeb, Roku, Alexa, SmartTV, FireTV, Xbox, Unknown
settings Array of objects for each feed setting. Each object should have a name and value. Not all feeds have settings.
is_debug If true, the feed data is sent to the development environment. true or false 
curl \
  -X PUT \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  -H "Content-Type: application/json" \
  -d "{ \
    \"module_name\": \"radar\", \
    \"name\": \"radariOSFeed\", \
    \"os\": \"ios\", \
    \"settings\": [], \
    \"is_debug\": true \
  }" \
  "https://api.mparticle.com/v1/workspace/1/partnerfeeds?accountId=1"
Example Response
{
    "data": [
        {
            "data_type": "Partner Feed",
            "id": 689,
            "created_on": "2019-07-16T20:46:45.25"
        }
    ],
    "data_type": "Partner Feed",
    "errors": null
}

List Output Configurations

GET /workspace/<workspace-id>/<module_name>/serviceconfigurations?accountId=1

List all available configurations for a particular module

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/workspace/3999/amplitude/serviceconfigurations?accountId=1`"
Example Response
{
    "data": [
        {
            "id": 24020,
            "name": "Amplitude Main Project",
            "data_type": "Service Configuration",
            "created_on": "2018-02-09T20:54:25.52"
        },
        {
            "id": 24022,
            "name": "Amplitude Development",
            "data_type": "Service Configuration",
            "created_on": "2018-02-12T21:02:11.317"
        }
    ],
    "data_type": "Service Configuration",
    "errors": null
}

List Feed Subscriptions

GET /partnerfeeds/<workspace-id>/subscriptions?accountId={{accountId}}

Returns a list of all feed subscriptions for a workspace. A subscription is a connection between a feed and an output configuration.

{
    "data": [
        {
            "settings": [
                {
                    "value": "True",
                    "name": "useCustomerId"
                }
            ],
            "is_active": false,
            "service_configuration_id": 24016,
            "config_name": "config1",
            "data_type": "Partner Feed Subscription",
            "id": 24572,
            "created_on": "2019-07-16T17:29:54.8934721Z"
        },
        {
            "settings": [],
            "is_active": false,
            "service_configuration_id": 22411,
            "config_name": "OutputConfiguration for Redshift Cluster",
            "data_type": "Partner Feed Subscription",
            "id": 24273,
            "created_on": "2019-07-16T17:29:54.9471796Z"
        }
    ],
    "data_type": "Partner Feed Subscription",
    "errors": null
}

Create Feed Subscription

POST /partnerfeeds/<module-id>/subscriptions?accountId=1

Creates and configures a new feed subscription.

Field Description Notes - examples
service_configuration_id Name of the feed module. radar
is_active If true, data from the feed is forwarded to the output service. true or false
settings Array of objects for each feed setting. Each object should have a name and value. Not all feeds have settings. 
curl \
  -X POST \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  -H "Content-Type: application/json" \
  -d "{ \
    \"service_configuration_id\": 24017, \
    \"is_active\": \false, \
    \"os\": \"ios\", \
    \"settings\": [{\"name\": \"useCustomerId\", \"value\": true}] \
  }" \
  "https://api.mparticle.com/v1/workspace/1/partnerfeeds?accountId=1"
Example Response
{
    "data": [
        {
            "data_type": "PartnerFeed Subscription",
            "id": 26368,
            "created_on": "2019-07-16T16:49:31.852015-04:00"
        }
    ],
    "data_type": "PartnerFeed Subscription",
    "errors": null
}

Workspaces

Get list of workspaces for an account

GET /workspace?accountId=1

Returns a list of all workspaces for an account. 

curl \
  -X GET \
  -H "Authorization: Bearer YWIxMjdi883GHBBDnjsdKAJQxNjdjYUUJABbg6hdI.8V6HhxW-" \
  "https://api.mparticle.com/v1/workspace?accountId=1`"
Example Response
{
  "data": [
    {
      "id": "4302",
      "name": "mP Traveller",
      "data_type": "workspace",
      "created_on": "2017-02-02T11:20:23"
    }
  ],
  "dataType": "workspace",
  "errors": null
}

Was this page helpful?