{"id":22827421,"url":"https://github.com/voxaai/voxa-mparticle","last_synced_at":"2025-03-31T00:43:38.997Z","repository":{"id":44024996,"uuid":"227910495","full_name":"VoxaAI/voxa-mparticle","owner":"VoxaAI","description":"Voxa plugin for mParticle Analytics platform","archived":false,"fork":false,"pushed_at":"2023-01-24T00:58:23.000Z","size":1037,"stargazers_count":0,"open_issues_count":14,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-18T15:54:58.433Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VoxaAI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-13T19:43:19.000Z","updated_at":"2020-01-06T15:51:29.000Z","dependencies_parsed_at":"2023-02-03T10:32:22.565Z","dependency_job_id":null,"html_url":"https://github.com/VoxaAI/voxa-mparticle","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VoxaAI%2Fvoxa-mparticle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VoxaAI%2Fvoxa-mparticle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VoxaAI%2Fvoxa-mparticle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VoxaAI%2Fvoxa-mparticle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VoxaAI","download_url":"https://codeload.github.com/VoxaAI/voxa-mparticle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246399789,"owners_count":20770907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-12T18:10:33.195Z","updated_at":"2025-03-31T00:43:38.979Z","avatar_url":"https://github.com/VoxaAI.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Voxa mParticle plugin\n\nA [mParticle](https://www.mparticle.com/) plugin for [Voxa](http://voxa.ai/)\n\n## Installation\n\n```\nyarn add voxa-mparticle\n```\n\n## Usage\n\n```javascript\nconst { VoxaApp } = require('voxa');\nconst voxaMParticle = require(\"voxa-mparticle\");\n\nconst voxaApp = new VoxaApp();\nconst mParticleConfig = {\n  apiKey: \"mParticle api key\",\n  apiSecret: \"mParticle api secret\",\n  suppressSending: false, // A flag to supress sending hits.\n};\n\nvoxaMParticle(voxaApp, mParticleConfig);\n```\n\nFeatures\n--------\n\n### Development and Production enviroments\n\nThe plugin will configure the enviroment of the batch events according to the `NODE_ENV` used. If `NODE_ENV` is equal to `production` it will create a production batch of events, otherwise it will use a development batch.\n\n### User identity\n\nUser attributes are saved as the user id, supported interfaces and voice platform (only Alexa for now)\n\n### Device information\n\nDevice information is gathered like device manufacturer (only Amazon for now), language and country.\n\n### Session information\n\nSession id and timestamps are added automatically to the batch when the session starts and ends.\n\n### Navigation events\n\nState transitions are added as navigation events when the transition happens.\n\n### Custom events\n\nYou can add any custom events inside your Voxa states. You will have the mParticle plugin available in your `voxaEvent`. You can pass a custom event string and custom attributes as an object.\n\nTo add any custom events you can use it like this:\n\n```javascript\nconst someCustomAttributes = {\n  example: true\n}\nvoxaEvent.mParticle.addCustomEvent(\"CustomEvent\", someCustomAttributes);\n```\n\n### Saving events\n\nThe plugin will automatically send events at the end of each request or at the end of the session.\n\n\nTODO\n--------\n\n- Add support for non Amazon Alexa devices (like 3rd party thermostats and speakers)\n- Add support for Google Assistant devices","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoxaai%2Fvoxa-mparticle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoxaai%2Fvoxa-mparticle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoxaai%2Fvoxa-mparticle/lists"}