{"componentChunkName":"component---src-templates-markdown-template-jsx","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/object-api/","result":{"data":{"pageMetadata":{"title":"Object API","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/object-api/","sourceCode":null,"metadataParent":{"title":"SDKs","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/","sourceCode":null,"hasVersionPicker":null,"metadataChildren":[{"title":"SDKs Introduction","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/introduction/","order":6.1,"label":null},{"title":"React Native","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/react-native/","order":6.2,"label":null},{"title":"iOS","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/iOS/","order":6.3,"label":null},{"title":"Android","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/android/","order":6.4,"label":null},{"title":"Java","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/java/","order":6.4,"label":null},{"title":"JavaScript","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/javascript/","order":6.5,"label":null},{"title":"Python","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/python/","order":6.6,"label":null},{"title":"Object API","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/object-api/","order":6.7,"label":null}],"metadataParent":{"title":"Developer Docs","path":"/guides/analytics/analytics-deprecated/developer-docs/","metadataChildren":[{"title":"Introduction","path":"/guides/analytics/analytics-deprecated/developer-docs/introduction/","order":1,"label":null},{"title":"Integrations","path":"/guides/analytics/analytics-deprecated/developer-docs/integrations/","order":4,"label":null},{"title":"Data Warehouses and Data Lakes","path":"/guides/analytics/analytics-deprecated/developer-docs/data-warehouses-lakes/","order":5,"label":null},{"title":"APIs","path":"/guides/analytics/analytics-deprecated/developer-docs/apis/","order":6,"label":null},{"title":"SDKs","path":"/guides/analytics/analytics-deprecated/developer-docs/sdks/","order":6,"label":null},{"title":"Developer Basics","path":"/guides/analytics/analytics-deprecated/developer-docs/developer-basics/","order":7,"label":null}],"metadataParent":{"title":"Analytics (Deprecated)","path":"/guides/analytics/analytics-deprecated/","metadataChildren":[{"title":"Introduction","path":"/guides/analytics/analytics-deprecated/introduction/","order":1.1,"label":null},{"title":"Developer Docs","path":"/guides/analytics/analytics-deprecated/developer-docs/","order":4,"label":null},{"title":"Identity Providers","path":"/guides/analytics/analytics-deprecated/identity-providers/","order":null,"label":null},{"title":"Settings","path":"/guides/analytics/analytics-deprecated/settings/","order":null,"label":null}],"metadataParent":{"title":"Analytics","path":"/guides/analytics/","metadataChildren":[{"title":"Introduction","path":"/guides/analytics/introduction/","order":1,"label":null},{"title":"Core Analytics (Beta)","path":"/guides/analytics/core-analytics/","order":1.1,"label":null},{"title":"Analytics Free Trial","path":"/guides/analytics/analytics-free-trial/","order":2,"label":null},{"title":"Setup","path":"/guides/analytics/setup/","order":3,"label":null},{"title":"Settings","path":"/guides/analytics/settings/","order":4,"label":null},{"title":"Analytics Data Manager","path":"/guides/analytics/data-manager/","order":5,"label":null},{"title":"Analyses","path":"/guides/analytics/analyses/","order":6,"label":null},{"title":"Query Builder","path":"/guides/analytics/query-builder/","order":6,"label":null},{"title":"User Aliasing","path":"/guides/analytics/user-aliasing/","order":7,"label":null},{"title":"Dashboards","path":"/guides/analytics/dashboards/","order":8,"label":null},{"title":"Analytics Resources","path":"/guides/analytics/resources/","order":10,"label":null},{"title":"User Segments","path":"/guides/analytics/user-segments/","order":10,"label":null},{"title":"Tutorials","path":"/guides/analytics/tutorials/","order":11,"label":null},{"title":"APIs","path":"/guides/analytics/apis/","order":12,"label":null},{"title":"Analytics (Deprecated)","path":"/guides/analytics/analytics-deprecated/","order":13,"label":null}],"metadataParent":{"title":"Guides","path":"/guides/","metadataChildren":[{"title":"Platform Overview","path":"/guides/platform-overview/","order":0.5,"label":null},{"title":"Getting Started","path":"/guides/getting-started/","order":1,"label":null},{"title":"mParticle Agent","path":"/guides/mparticle-agent/","order":1.5,"label":null},{"title":"Oversight","path":"/guides/oversight/","order":2,"label":null},{"title":"Data Platform","path":"/guides/data-platform/","order":3,"label":null},{"title":"Data Warehouse","path":"/guides/data-warehouse/","order":4,"label":null},{"title":"Customer 360","path":"/guides/customer-360/","order":5,"label":null},{"title":"Analytics","path":"/guides/analytics/","order":6,"label":null},{"title":"Audiences","path":"/guides/audiences/","order":7,"label":null},{"title":"Settings","path":"/guides/settings/","order":8,"label":null},{"title":"Troubleshooting mParticle","path":"/guides/troubleshooting/","order":10,"label":null},{"title":"Default Service Limits","path":"/guides/default-service-limits/","order":11,"label":null},{"title":"Glossary","path":"/guides/glossary/","order":12,"label":null}]}}}}}},"markdownRemark":{"html":"<aside class=\"warning\">\n<strong>Analytics Sunset</strong><br />\nWe began sunsetting mParticle Analytics on October 1, 2026. As a result, the features and workflows described on this page may no longer be available. This documentation is retained for reference. If you have questions about how this change affects your account, contact your mParticle account representative.\n</aside>\n<table>\n<thead>\n<tr>\n<th>Method Call and Parameters</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code class=\"language-text\">Indicative.initialize(apiKey);</code></td>\n<td>Initializes the Analytics object to be ready for use. Must contain your project’s unique apiKey.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">apiKey: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.getProperties();</code></td>\n<td>Returns an object of the stateful properties.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">no parameters</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.addProperties(obj);</code></td>\n<td>Adds a list or object of properties to the object of stateful properties. Can be an object or an array, see docs for further info.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">obj: Obj \\| Array</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.addProperty(name, value);</code></td>\n<td>Add a single property to the object of stateful properties. Must include a String name and String, Number, or Boolean value.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">name: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">value: String \\| Number \\| Boolean</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.removeProperty(name);</code></td>\n<td>Removes a single property from the stateful properties object.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">name: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.clearProperties();</code></td>\n<td>Clears all stateful properties.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">no parameters</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.setUniqueID(id);</code></td>\n<td>Sets a stateful uniqueID to be used for all events built without a uniqueID.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">id: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.clearUniqueID(id);</code></td>\n<td>Clears the stateful uniqueID. If you set <code class=\"language-text\">id=true</code> it will also clear the automatically generated anonymous ID</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">id: Boolean</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.buildEvent(eventName);</code></td>\n<td>Records an event with the given eventName, using the unique ID stored as a cookie (Random UUID if not set manually using <code class=\"language-text\">Indicative.setUniqueID(id)</code>). Refer to building an event above for more information.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">eventName: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.buildEvent(eventName, id);</code></td>\n<td>Records an event with the given eventName and unique id. It will only set this event’s unique id. Refer to building an event above for more information.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">eventName: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">id: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.buildEvent(eventName, id, propmap);</code></td>\n<td>Records an event with the given eventName, unique id, and property map. The property map can be an object or array and will only be used for this event. Refer to building an event above for formatting guidelines.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">eventName: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">id: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">propmap: Obj \\| Array</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.buildEvent(eventName, propmap);</code></td>\n<td>Records an event with the given eventName and property map. The property map can be an object or array and will only be used for this event. Refer to building an event above for more information.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">eventName: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">propmap: Obj \\| Array</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.buildEvent(eventName, callback);</code></td>\n<td>Records an event with the given eventName and callback function. It will use the default unique id. The callback function will be called after successful or unsuccessful POST. Refer to building an event above for more information.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">eventName: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">callback: Func</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.buildEvent(eventName, id, callback);</code></td>\n<td>Records an event with the given eventName, unique id, and callback function. It will record this event’s unique id. The callback function will be called after successful or unsuccessful POST. Refer to building an event above for more information.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">eventName: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">id: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">callback: Func</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.buildEvent(eventName, id, propmap, callback);</code></td>\n<td>Records an event with the given eventName, unique id, property map, and callback function. The property map can be an object or array and will only be used for this event. The callback function will be called after successful or unsuccessful POST. Refer to building an event above for more information.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">eventName: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">id: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">propmap: Obj \\| Array</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">callback: Func</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.buildEvent(eventName, propmap, callback);</code></td>\n<td>Records an event with the given eventName, property map, and callback function. The property map can be an object or array and will only be used for this event. The callback function will be called after successful or unsuccessful POST. Refer to building an event above for more information.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">eventName: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">propmap: Obj \\| Array</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">callback: Func</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.setUniqueID(id, true);</code></td>\n<td>This will automatically call <code class=\"language-text\">Indicative.sendAlias()</code> after setting the new unique ID. If you just call <code class=\"language-text\">Indicative.setUniqueID(id)</code> without ‘true’, it will not send the alias call.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">id: String</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code class=\"language-text\">Indicative.sendAlias();</code></td>\n<td>The Indicative client automatically generates a default unique ID (a UUID) to use on all events until <code class=\"language-text\">Indicative.setUniqueID(id)</code> is called. At that point, <code class=\"language-text\">Indicative.sendAlias()</code> can be called to alias the UUID to the ‘id’ parameter set within <code class=\"language-text\">Indicative.setUniqueID(id)</code>.</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">no parameters</code></td>\n<td></td>\n</tr>\n</tbody>\n</table>","frontmatter":{"title":"Object API","order":6.7,"seoTitle":null,"seoDescription":null},"parent":{"__typename":"File","modifiedTime":"October 12, 2026"}}},"pageContext":{"slug":"/guides/analytics/analytics-deprecated/developer-docs/sdks/object-api/"}},"staticQueryHashes":["2950460867"]}