Profile API

Localytics provides a simple REST API to store and retrieve profile information about your users.

A profile is a collection of arbitrary key-value pairs represented in JSON format.

{
  "attributes": {
    "name": "Isa",
    "cats": ["Ofelia", "Mittens", "Spot", "Schrödinger"],
    "age": 30,
    "lucky numbers": [1, 48, -100, 13],
    "birthday": "1983-01-01"
  }
}

As a Localytics customer, your organization has access to its own private profile database, which can store an unlimited number of profiles, each identified by a unique customer ID that you provide. Use this database to store customer profile information that could be useful across any number of your apps (such as age, location, or birthday). The Localytics Profile API currently exposes profiles for your organization-wide database as a single RESTful resource at the following URL.

https://profile.localytics.com/v1/profiles/:customer_id

Each app in your organization also comes with its own profile database, where you can store app-specific profile information that may not be relevant to your other apps (such as high score, items purchased, or favorite baseball team). Access these app-specific Profiles databases via the same RESTful methods at the following URL.

https://profile.localytics.com/v1/apps/:app_id/profiles/:customer_id

Both resources accept the HTTP methods GET, PATCH, and DELETE.

Note:

A few limits apply to data uploaded to the Localytics Profiles API.

Customer IDs must be no longer than 128 characters, or 128 bytes.
Individual profiles may not exceed 400KB in size. Attempts to upload profiles larger than 400KB, or requests which would cause a profile to exceed this limit, will result in a 413 Request Entity Too Large response.