{"_id":"54c8b32ab3334c0d00236657","version":"54c8b329b3334c0d00236654","category":"54c8b36919d1910d004feb68","project":"545386120c09721000a069f5","sync_unique":"","title":"Getting Started","type":"basic","api":{"auth":"never","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Documentation is always work in progress\",\n  \"body\": \"We enjoy writing documentation for our system so that you can build fantastic tools with it. This is always work in progress: we might occasionally add examples and fixes. \\n\\nSome resources are not yet fully documented but they support all CRUD methods: GET, POST, PUT, PATCH, DELETE\\n\\n**If you find any mistakes, please contact us at support@movintracks.io**\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Overview\"\n}\n[/block]\nMovintracks is a proximal marketing platform. You can create **campaigns** for devices using a dashboard. Campaigns launch **actions** (e.g. deliver a coupon, show a message, show an image, interact with a social network...) and are **triggered** when certain conditions are met (e.g. visit a point, when it's between 9am and 10.30am, after 15min in a point, etc).\n\nThe system has 3 parts: a **web dashboard**, a **REST API** and an **SDK for Android and iOS**.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"REST API\",\n  \"body\": \"Use the REST API to create campaigns automatically based on information in your CRM or database, to fetch statistics and raw data or even to make your own dashboard. \\n\\nBuild amazing things and tell us about them!\"\n}\n[/block]\nUse the web dashboard to create campaigns, points, zones and coupons amonst others. Integrate the SDK in your app to automagically enable the use of beacon technology. Use the API to interoperate with our system and save time.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"SDK for Android and iOS\",\n  \"body\": \"The SDK is available for Android and iOS. It's easy to integrate and enables your application to use beacon technology and marketing campaigns configured with Movintracks, either using the Dashboard or using the REST API.\\nThere is even an endpoint in the API so that you know which is the latest version and where to download it.\"\n}\n[/block]\nHint: there is an endpoint for the SDK.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Entities\"\n}\n[/block]\nThe Movintracks API lets you create **campaigns** with **triggers** and **actions**. Actions (contents) of a campaign are launched when certain conditions (the triggers) are met.\n\nCampaigns are linked to **points**, a virtual representation of places marked with **beacons** in a shop, museum or your facilities. Points belong to a **zone**, which is normally as big as a building and is represented with a center and a radius. \n\nExample of actions: show a survey, show a message, open a URL (a landing page, Vimeo, Youtube, anything).\nExamples of triggers: on visiting a point, if users is following me, if it's between 3-5pm.\n\nCampaigns belong to **apps**, that have an API Key and a secret key. An app is a virtual representation of your mobile project. You can input there the bundle ID or package name, and any other details that help you identify it. And, of course, apps belong to **you**.\n\nThe API lets you perform CRUD operations on most of entities using HTTP verbs, like with any other REST API. Some others have limited access or are read only (e.g. statistics or information about the SDK).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Operations\"\n}\n[/block]\nMost resources support the standard REST methods **GET**, **POST**, **PUT**, **PATCH**, **DELETE**.\n\nIn case of doubt, you can also issue an **OPTIONS** request and it will return some more hints, although it isn't an exhaustive list of options.\n\nYour dashboard user has privileges to operate with all resources but not to tamper with stats captured by devices.","createdAt":"2014-10-31T12:52:34.547Z","link_url":"","order":0,"excerpt":"This page will help you get started with Movintracks.","githubsync":"","hidden":false,"link_external":false,"slug":"getting-started","__v":14,"updates":[],"user":"545383ac08d1800800473d8d","childrenPages":[]}

Getting Started

This page will help you get started with Movintracks.

[block:callout] { "type": "info", "title": "Documentation is always work in progress", "body": "We enjoy writing documentation for our system so that you can build fantastic tools with it. This is always work in progress: we might occasionally add examples and fixes. \n\nSome resources are not yet fully documented but they support all CRUD methods: GET, POST, PUT, PATCH, DELETE\n\n**If you find any mistakes, please contact us at support@movintracks.io**" } [/block] [block:api-header] { "type": "basic", "title": "Overview" } [/block] Movintracks is a proximal marketing platform. You can create **campaigns** for devices using a dashboard. Campaigns launch **actions** (e.g. deliver a coupon, show a message, show an image, interact with a social network...) and are **triggered** when certain conditions are met (e.g. visit a point, when it's between 9am and 10.30am, after 15min in a point, etc). The system has 3 parts: a **web dashboard**, a **REST API** and an **SDK for Android and iOS**. [block:callout] { "type": "info", "title": "REST API", "body": "Use the REST API to create campaigns automatically based on information in your CRM or database, to fetch statistics and raw data or even to make your own dashboard. \n\nBuild amazing things and tell us about them!" } [/block] Use the web dashboard to create campaigns, points, zones and coupons amonst others. Integrate the SDK in your app to automagically enable the use of beacon technology. Use the API to interoperate with our system and save time. [block:callout] { "type": "info", "title": "SDK for Android and iOS", "body": "The SDK is available for Android and iOS. It's easy to integrate and enables your application to use beacon technology and marketing campaigns configured with Movintracks, either using the Dashboard or using the REST API.\nThere is even an endpoint in the API so that you know which is the latest version and where to download it." } [/block] Hint: there is an endpoint for the SDK. [block:api-header] { "type": "basic", "title": "Entities" } [/block] The Movintracks API lets you create **campaigns** with **triggers** and **actions**. Actions (contents) of a campaign are launched when certain conditions (the triggers) are met. Campaigns are linked to **points**, a virtual representation of places marked with **beacons** in a shop, museum or your facilities. Points belong to a **zone**, which is normally as big as a building and is represented with a center and a radius. Example of actions: show a survey, show a message, open a URL (a landing page, Vimeo, Youtube, anything). Examples of triggers: on visiting a point, if users is following me, if it's between 3-5pm. Campaigns belong to **apps**, that have an API Key and a secret key. An app is a virtual representation of your mobile project. You can input there the bundle ID or package name, and any other details that help you identify it. And, of course, apps belong to **you**. The API lets you perform CRUD operations on most of entities using HTTP verbs, like with any other REST API. Some others have limited access or are read only (e.g. statistics or information about the SDK). [block:api-header] { "type": "basic", "title": "Operations" } [/block] Most resources support the standard REST methods **GET**, **POST**, **PUT**, **PATCH**, **DELETE**. In case of doubt, you can also issue an **OPTIONS** request and it will return some more hints, although it isn't an exhaustive list of options. Your dashboard user has privileges to operate with all resources but not to tamper with stats captured by devices.
View all 181 endpoints
[block:callout] { "type": "info", "title": "Documentation is always work in progress", "body": "We enjoy writing documentation for our system so that you can build fantastic tools with it. This is always work in progress: we might occasionally add examples and fixes. \n\nSome resources are not yet fully documented but they support all CRUD methods: GET, POST, PUT, PATCH, DELETE\n\n**If you find any mistakes, please contact us at support@movintracks.io**" } [/block] [block:api-header] { "type": "basic", "title": "Overview" } [/block] Movintracks is a proximal marketing platform. You can create **campaigns** for devices using a dashboard. Campaigns launch **actions** (e.g. deliver a coupon, show a message, show an image, interact with a social network...) and are **triggered** when certain conditions are met (e.g. visit a point, when it's between 9am and 10.30am, after 15min in a point, etc). The system has 3 parts: a **web dashboard**, a **REST API** and an **SDK for Android and iOS**. [block:callout] { "type": "info", "title": "REST API", "body": "Use the REST API to create campaigns automatically based on information in your CRM or database, to fetch statistics and raw data or even to make your own dashboard. \n\nBuild amazing things and tell us about them!" } [/block] Use the web dashboard to create campaigns, points, zones and coupons amonst others. Integrate the SDK in your app to automagically enable the use of beacon technology. Use the API to interoperate with our system and save time. [block:callout] { "type": "info", "title": "SDK for Android and iOS", "body": "The SDK is available for Android and iOS. It's easy to integrate and enables your application to use beacon technology and marketing campaigns configured with Movintracks, either using the Dashboard or using the REST API.\nThere is even an endpoint in the API so that you know which is the latest version and where to download it." } [/block] Hint: there is an endpoint for the SDK. [block:api-header] { "type": "basic", "title": "Entities" } [/block] The Movintracks API lets you create **campaigns** with **triggers** and **actions**. Actions (contents) of a campaign are launched when certain conditions (the triggers) are met. Campaigns are linked to **points**, a virtual representation of places marked with **beacons** in a shop, museum or your facilities. Points belong to a **zone**, which is normally as big as a building and is represented with a center and a radius. Example of actions: show a survey, show a message, open a URL (a landing page, Vimeo, Youtube, anything). Examples of triggers: on visiting a point, if users is following me, if it's between 3-5pm. Campaigns belong to **apps**, that have an API Key and a secret key. An app is a virtual representation of your mobile project. You can input there the bundle ID or package name, and any other details that help you identify it. And, of course, apps belong to **you**. The API lets you perform CRUD operations on most of entities using HTTP verbs, like with any other REST API. Some others have limited access or are read only (e.g. statistics or information about the SDK). [block:api-header] { "type": "basic", "title": "Operations" } [/block] Most resources support the standard REST methods **GET**, **POST**, **PUT**, **PATCH**, **DELETE**. In case of doubt, you can also issue an **OPTIONS** request and it will return some more hints, although it isn't an exhaustive list of options. Your dashboard user has privileges to operate with all resources but not to tamper with stats captured by devices.
{"_id":"5517d2a1f732e32100056ef5","api":{"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"body":"There are some limits and constraints to prevent abusing the system and to protect (and keep serving!) all users.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Throttling\"\n}\n[/block]\nAll endpoints support a maximum rate of 90 requests / minute.\nIf this is too short for you, please contact Movintracks. Avoid polling.\nHowever, when it comes to using push notifications (e.g. POST /v2.0/devices/notify/) the limit is 1 request / 15 minutes.\nThis rate can be changed at anytime.\nWhen you exceed this limit, the system returns a status code 429 and tells you the time you have to wait for performing the next request.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Maximum number of Application\"\n}\n[/block]\nUsers can only have 1 application.","order":1,"project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","createdAt":"2015-03-29T10:23:29.505Z","excerpt":"","githubsync":"","title":"Limits","type":"basic","__v":3,"category":"54c8b36919d1910d004feb68","hidden":false,"link_external":false,"sync_unique":"","updates":[],"link_url":"","slug":"limits","version":"54c8b329b3334c0d00236654","childrenPages":[]}

Limits


There are some limits and constraints to prevent abusing the system and to protect (and keep serving!) all users. [block:api-header] { "type": "basic", "title": "Throttling" } [/block] All endpoints support a maximum rate of 90 requests / minute. If this is too short for you, please contact Movintracks. Avoid polling. However, when it comes to using push notifications (e.g. POST /v2.0/devices/notify/) the limit is 1 request / 15 minutes. This rate can be changed at anytime. When you exceed this limit, the system returns a status code 429 and tells you the time you have to wait for performing the next request. [block:api-header] { "type": "basic", "title": "Maximum number of Application" } [/block] Users can only have 1 application.
There are some limits and constraints to prevent abusing the system and to protect (and keep serving!) all users. [block:api-header] { "type": "basic", "title": "Throttling" } [/block] All endpoints support a maximum rate of 90 requests / minute. If this is too short for you, please contact Movintracks. Avoid polling. However, when it comes to using push notifications (e.g. POST /v2.0/devices/notify/) the limit is 1 request / 15 minutes. This rate can be changed at anytime. When you exceed this limit, the system returns a status code 429 and tells you the time you have to wait for performing the next request. [block:api-header] { "type": "basic", "title": "Maximum number of Application" } [/block] Users can only have 1 application.
{"_id":"55b74a792764c20d008d7d2f","title":"Integration with Oracle Sales Cloud","updates":[],"excerpt":"","hidden":false,"createdAt":"2015-07-28T09:25:13.261Z","sync_unique":"","user":"545383ac08d1800800473d8d","order":2,"version":"54c8b329b3334c0d00236654","__v":5,"body":"Movintracks is the first proximity campaign manager to achieve Gold Partner status in the Oracle Partner Network (OPN).\n\n**This section does not explain the integration procedure. This information will be provided in the Oracle Marketplace**.\nThis section explains the entities you can use in Movintracks to interoperate with Oracle Sales Cloud.\n\nFind the [Movintracks Connector for Beacons in the Oracle Marketplace](https://cloud.oracle.com/marketplace/listing/4033341/Movintracks-Barcelona-SL/Movintracks-Connector-for-Beacons) and click on Get App. You will receive detailed instructions that will help you set-up your instance.\n\nIf you have an Oracle Sales Cloud account, you can enable certain features in Movintracks that will help you benefit from the power of proximity technology in your CRM. \nFor example, you can add an action of type Sales Cloud Activity. When the campaign launches, context data (campaign, zone, point, beacon IDs and timestamp) will be added as an Activity for the Sales Cloud Contact using the mobile app.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Create Oracle Sales Cloud Activities automatically\",\n  \"body\": \"Get context information and track user behaviour in your facilities with the new *Action Oracle Sales Cloud Activity*.\"\n}\n[/block]\nUse your mobile application backend to link a Movintracks Device ID with your Sales Cloud Contact, or input it manually using the Simplified UI or the Desktop UI.\n\nAssuming your Sales Cloud instance is set-up you'll only need to take 2 steps:\n\n1. Input your Sales Cloud credentials to Movintracks using either the [Fusion Apps User endpoint](http://movintracks.readme.io/docs/fusion-apps-user-get) or [https://dashboard.movintracks.io](https://dashboard.movintracks.io).\n2. Create a Movintracks Campaign with an [action Oracle Sales Cloud Activity](http://movintracks.readme.io/docs/actions-oracle-sales-cloud-activity-get-all).\n\nNow when user visits a Zone or a Point, Sales Cloud will create automatically an Activity linked to them giving you context information.","link_external":false,"link_url":"","project":"545386120c09721000a069f5","slug":"overview-integration-with-oracle-sales-cloud","type":"basic","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"category":"54c8b36919d1910d004feb68","githubsync":"","childrenPages":[]}

Integration with Oracle Sales Cloud


Movintracks is the first proximity campaign manager to achieve Gold Partner status in the Oracle Partner Network (OPN). **This section does not explain the integration procedure. This information will be provided in the Oracle Marketplace**. This section explains the entities you can use in Movintracks to interoperate with Oracle Sales Cloud. Find the [Movintracks Connector for Beacons in the Oracle Marketplace](https://cloud.oracle.com/marketplace/listing/4033341/Movintracks-Barcelona-SL/Movintracks-Connector-for-Beacons) and click on Get App. You will receive detailed instructions that will help you set-up your instance. If you have an Oracle Sales Cloud account, you can enable certain features in Movintracks that will help you benefit from the power of proximity technology in your CRM. For example, you can add an action of type Sales Cloud Activity. When the campaign launches, context data (campaign, zone, point, beacon IDs and timestamp) will be added as an Activity for the Sales Cloud Contact using the mobile app. [block:callout] { "type": "info", "title": "Create Oracle Sales Cloud Activities automatically", "body": "Get context information and track user behaviour in your facilities with the new *Action Oracle Sales Cloud Activity*." } [/block] Use your mobile application backend to link a Movintracks Device ID with your Sales Cloud Contact, or input it manually using the Simplified UI or the Desktop UI. Assuming your Sales Cloud instance is set-up you'll only need to take 2 steps: 1. Input your Sales Cloud credentials to Movintracks using either the [Fusion Apps User endpoint](http://movintracks.readme.io/docs/fusion-apps-user-get) or [https://dashboard.movintracks.io](https://dashboard.movintracks.io). 2. Create a Movintracks Campaign with an [action Oracle Sales Cloud Activity](http://movintracks.readme.io/docs/actions-oracle-sales-cloud-activity-get-all). Now when user visits a Zone or a Point, Sales Cloud will create automatically an Activity linked to them giving you context information.
Movintracks is the first proximity campaign manager to achieve Gold Partner status in the Oracle Partner Network (OPN). **This section does not explain the integration procedure. This information will be provided in the Oracle Marketplace**. This section explains the entities you can use in Movintracks to interoperate with Oracle Sales Cloud. Find the [Movintracks Connector for Beacons in the Oracle Marketplace](https://cloud.oracle.com/marketplace/listing/4033341/Movintracks-Barcelona-SL/Movintracks-Connector-for-Beacons) and click on Get App. You will receive detailed instructions that will help you set-up your instance. If you have an Oracle Sales Cloud account, you can enable certain features in Movintracks that will help you benefit from the power of proximity technology in your CRM. For example, you can add an action of type Sales Cloud Activity. When the campaign launches, context data (campaign, zone, point, beacon IDs and timestamp) will be added as an Activity for the Sales Cloud Contact using the mobile app. [block:callout] { "type": "info", "title": "Create Oracle Sales Cloud Activities automatically", "body": "Get context information and track user behaviour in your facilities with the new *Action Oracle Sales Cloud Activity*." } [/block] Use your mobile application backend to link a Movintracks Device ID with your Sales Cloud Contact, or input it manually using the Simplified UI or the Desktop UI. Assuming your Sales Cloud instance is set-up you'll only need to take 2 steps: 1. Input your Sales Cloud credentials to Movintracks using either the [Fusion Apps User endpoint](http://movintracks.readme.io/docs/fusion-apps-user-get) or [https://dashboard.movintracks.io](https://dashboard.movintracks.io). 2. Create a Movintracks Campaign with an [action Oracle Sales Cloud Activity](http://movintracks.readme.io/docs/actions-oracle-sales-cloud-activity-get-all). Now when user visits a Zone or a Point, Sales Cloud will create automatically an Activity linked to them giving you context information.
{"_id":"54c8b6aa4574700d00f015ec","link_external":false,"githubsync":"","category":"54d3683469578e0d0027310f","sync_unique":"","title":"Authentication Overview","type":"basic","api":{"auth":"required","params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"All endpoints except root require authorization with oAuth2. You have to request a token and pass it in the header to all requests.\nAll communication goes through https. If you use http, you will be redirected to https.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"HTTPS\",\n  \"body\": \"Always use https with the Movintracks API\"\n}\n[/block]\nYou can request a token with your favourite library which is, of course, [requests](http://docs.python-requests.org), with [HTTPie](https://github.com/jakubroztocil/httpie) or with any other tool. You can use plain cURL but you'll be tired soon.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"pip install httpie\",\n  \"body\": \"[HTTPie](https://github.com/jakubroztocil/httpie) is a command line HTTP client, a user-friendly cURL replacement.\\nInstall it with pip:\\n$ pip install httpie\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http -f POST https://api.movintracks.io/oauth2/access_token client_id=$MT_API_KEY grant_type=password username=$MT_USERNAME password=$MT_PASSWORD\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nYou can find your client ID (the API Key) in your dashboard. It's a unique API key per application. You can use it to make requests using your favourite library, and the SDK will use it to talk to our system.\n\nSubsequent requests will need the token you just got:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http https://api.movintracks.io/v2.0/static-pages \\\"Authorization: Bearer $MT_TOKEN\\\"\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nYou can learn more about this in the following sections.","createdAt":"2015-01-28T10:15:06.199Z","slug":"authorization","updates":[],"version":"54c8b329b3334c0d00236654","__v":9,"hidden":false,"link_url":"","order":0,"project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","excerpt":"","childrenPages":[]}

Authentication Overview


All endpoints except root require authorization with oAuth2. You have to request a token and pass it in the header to all requests. All communication goes through https. If you use http, you will be redirected to https. [block:callout] { "type": "warning", "title": "HTTPS", "body": "Always use https with the Movintracks API" } [/block] You can request a token with your favourite library which is, of course, [requests](http://docs.python-requests.org), with [HTTPie](https://github.com/jakubroztocil/httpie) or with any other tool. You can use plain cURL but you'll be tired soon. [block:callout] { "type": "info", "title": "pip install httpie", "body": "[HTTPie](https://github.com/jakubroztocil/httpie) is a command line HTTP client, a user-friendly cURL replacement.\nInstall it with pip:\n$ pip install httpie" } [/block] [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/oauth2/access_token client_id=$MT_API_KEY grant_type=password username=$MT_USERNAME password=$MT_PASSWORD", "language": "shell" } ] } [/block] You can find your client ID (the API Key) in your dashboard. It's a unique API key per application. You can use it to make requests using your favourite library, and the SDK will use it to talk to our system. Subsequent requests will need the token you just got: [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/static-pages \"Authorization: Bearer $MT_TOKEN\"", "language": "shell" } ] } [/block] You can learn more about this in the following sections.
All endpoints except root require authorization with oAuth2. You have to request a token and pass it in the header to all requests. All communication goes through https. If you use http, you will be redirected to https. [block:callout] { "type": "warning", "title": "HTTPS", "body": "Always use https with the Movintracks API" } [/block] You can request a token with your favourite library which is, of course, [requests](http://docs.python-requests.org), with [HTTPie](https://github.com/jakubroztocil/httpie) or with any other tool. You can use plain cURL but you'll be tired soon. [block:callout] { "type": "info", "title": "pip install httpie", "body": "[HTTPie](https://github.com/jakubroztocil/httpie) is a command line HTTP client, a user-friendly cURL replacement.\nInstall it with pip:\n$ pip install httpie" } [/block] [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/oauth2/access_token client_id=$MT_API_KEY grant_type=password username=$MT_USERNAME password=$MT_PASSWORD", "language": "shell" } ] } [/block] You can find your client ID (the API Key) in your dashboard. It's a unique API key per application. You can use it to make requests using your favourite library, and the SDK will use it to talk to our system. Subsequent requests will need the token you just got: [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/static-pages \"Authorization: Bearer $MT_TOKEN\"", "language": "shell" } ] } [/block] You can learn more about this in the following sections.
{"_id":"54ca1b5bdd5cf30d00c35138","api":{"url":"/oauth2/access_token","auth":"required","method":"post","params":[{"desc":"The client ID (API Key) shown in your dashboard","name":"client_id","required":false,"type":"string","in":"body","_id":"54ca1b5bdd5cf30d00c3513c","default":""},{"type":"string","name":"username","in":"body","_id":"54ca1b5bdd5cf30d00c3513b","required":false,"desc":"Your dashboard username","default":""},{"_id":"54ca1b5bdd5cf30d00c3513a","required":false,"desc":"Your dashboard password","default":"","type":"string","name":"password","in":"body"},{"_id":"54ca1b5bdd5cf30d00c35139","default":"password","desc":"authentication type. By default, the word \"password\"","name":"grant_type","required":false,"type":"string","in":"body"}],"results":{"codes":[{"name":"","code":"{\n    \"access_token\": \"96951859044ebb769cdeac39428166c4760a6f2a\",\n    \"expires_in\": 2591999,\n    \"scope\": \"read\",\n    \"token_type\": \"Bearer\"\n}","language":"json","status":200},{"name":"","code":"HTTP/1.0 400 BAD REQUEST\nCache-Control: no-store\nContent-Type: application/json\nDate: Thu, 29 Jan 2015 11:36:16 GMT\nLast-Modified: Thu, 29 Jan 2015 10:36:16 GMT\nPragma: no-cache\nServer: WSGIServer/0.1 Python/2.7.6\nX-Frame-Options: SAMEORIGIN\n\n{\n    \"error\": \"invalid_client\"\n}","language":"json","status":400}]},"settings":""},"createdAt":"2015-01-29T11:36:59.685Z","slug":"authorization-1","project":"545386120c09721000a069f5","updates":[],"__v":0,"category":"54d3683469578e0d0027310f","editedParams":true,"githubsync":"","link_external":false,"link_url":"","user":"545383ac08d1800800473d8d","editedParams2":true,"hidden":false,"sync_unique":"","version":"54c8b329b3334c0d00236654","body":"All endpoints except root require authorization with oAuth2. You have to request a token and pass it in the header to all requests as a form. Requesting a token works like posting a form:\n**Content-Type: application/x-www-form-urlencoded; charset=utf-8**\nUsing any other resource, uses json.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"POST a form to request an access token\",\n  \"body\": \"Notice the key=value format and the `-f` parameter for httpie\\n\\nContent-Type: application/x-www-form-urlencoded; charset=utf-8\"\n}\n[/block]\nForm example, with httpie:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http -f POST https://api.movintracks.io/oauth2/access_token client_id=$MT_API_KEY grant_type=password username=$MT_USERNAME password=$MT_PASSWORD\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nYou can find your client ID (your API Key) in your dashboard. There is a unique API key for each application.\n\nNotice the key=value format and the `-f` parameter for httpie, as explained in the [oAuth2 Django Docs](http://django-oauth2-provider.readthedocs.org/en/latest/getting_started.html#how-to-request-an-access-token-for-the-first-time)\nSubsequent requests will need the access_token you just got:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http https://api.movintracks.io/v2.0/static-pages \\\"Authorization:Bearer $MT_TOKEN\\\"\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"","order":1,"title":"Obtain an access token","type":"post","childrenPages":[]}

postObtain an access token


Body Params

client_id:
string
The client ID (API Key) shown in your dashboard
username:
string
Your dashboard username
password:
string
Your dashboard password
grant_type:
stringpassword
authentication type. By default, the word "password"
All endpoints except root require authorization with oAuth2. You have to request a token and pass it in the header to all requests as a form. Requesting a token works like posting a form: **Content-Type: application/x-www-form-urlencoded; charset=utf-8** Using any other resource, uses json. [block:callout] { "type": "warning", "title": "POST a form to request an access token", "body": "Notice the key=value format and the `-f` parameter for httpie\n\nContent-Type: application/x-www-form-urlencoded; charset=utf-8" } [/block] Form example, with httpie: [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/oauth2/access_token client_id=$MT_API_KEY grant_type=password username=$MT_USERNAME password=$MT_PASSWORD", "language": "shell" } ] } [/block] You can find your client ID (your API Key) in your dashboard. There is a unique API key for each application. Notice the key=value format and the `-f` parameter for httpie, as explained in the [oAuth2 Django Docs](http://django-oauth2-provider.readthedocs.org/en/latest/getting_started.html#how-to-request-an-access-token-for-the-first-time) Subsequent requests will need the access_token you just got: [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/static-pages \"Authorization:Bearer $MT_TOKEN\"", "language": "shell" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



All endpoints except root require authorization with oAuth2. You have to request a token and pass it in the header to all requests as a form. Requesting a token works like posting a form: **Content-Type: application/x-www-form-urlencoded; charset=utf-8** Using any other resource, uses json. [block:callout] { "type": "warning", "title": "POST a form to request an access token", "body": "Notice the key=value format and the `-f` parameter for httpie\n\nContent-Type: application/x-www-form-urlencoded; charset=utf-8" } [/block] Form example, with httpie: [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/oauth2/access_token client_id=$MT_API_KEY grant_type=password username=$MT_USERNAME password=$MT_PASSWORD", "language": "shell" } ] } [/block] You can find your client ID (your API Key) in your dashboard. There is a unique API key for each application. Notice the key=value format and the `-f` parameter for httpie, as explained in the [oAuth2 Django Docs](http://django-oauth2-provider.readthedocs.org/en/latest/getting_started.html#how-to-request-an-access-token-for-the-first-time) Subsequent requests will need the access_token you just got: [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/static-pages \"Authorization:Bearer $MT_TOKEN\"", "language": "shell" } ] } [/block]
{"_id":"54d36a1eeefae10d0016cfca","slug":"using-an-access-token","sync_unique":"","title":"Use an access token","updates":[],"createdAt":"2015-02-05T13:03:26.894Z","githubsync":"","hidden":false,"order":2,"user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","__v":5,"api":{"url":"","auth":"required","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":""},"type":"basic","link_url":"","project":"545386120c09721000a069f5","body":"Pass your token in the header of all requests to endpoints that require authentication:\n\n**Authentication: Bearer $MT_TOKEN** \n\nFor example, in order to request your Points, try:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http https://api.movintracks.io/v2.0/points \\\"Authorization:Bearer  $MT_TOKEN\\\"\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nIf you don't provide a valid token, the API returns 401 Unauthorized or 403 Forbidden.","category":"54d3683469578e0d0027310f","excerpt":"","link_external":false,"childrenPages":[]}

Use an access token


Pass your token in the header of all requests to endpoints that require authentication: **Authentication: Bearer $MT_TOKEN** For example, in order to request your Points, try: [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/points \"Authorization:Bearer $MT_TOKEN\"", "language": "shell" } ] } [/block] If you don't provide a valid token, the API returns 401 Unauthorized or 403 Forbidden.
Pass your token in the header of all requests to endpoints that require authentication: **Authentication: Bearer $MT_TOKEN** For example, in order to request your Points, try: [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/points \"Authorization:Bearer $MT_TOKEN\"", "language": "shell" } ] } [/block] If you don't provide a valid token, the API returns 401 Unauthorized or 403 Forbidden.
{"_id":"5517dc97b625a50d001260b3","hidden":false,"project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","__v":4,"createdAt":"2015-03-29T11:05:59.705Z","excerpt":"Get all actions of type app custom callback","githubsync":"","link_external":false,"order":0,"slug":"actions-app-custom-callback-get-all","type":"get","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 1,\n    \"name\": \"destroy_death_star\",\n    \"order\": 3,\n    \"params\": {\n      \"lead\": \"Luke Skywalker\",\n      \"commander\": \"Princess Leia\"\n    },\n    \"type\": \"ActionAppCustomCallback\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-app-custom-callback/1/\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-app-custom-callback"},"sync_unique":"","body":"","category":"5517d05cb625a50d001260a8","link_url":"","title":"Get All Actions App Custom Callback","updates":[],"childrenPages":[]}

getGet All Actions App Custom Callback

Get all actions of type app custom callback

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551e96fca4f7771700ff7edc","sync_unique":"","type":"get","updates":[],"title":"Get One Action App Custom Callback","version":"54c8b329b3334c0d00236654","__v":2,"createdAt":"2015-04-03T13:34:52.211Z","excerpt":"Get one action of type app custom callback","githubsync":"","link_external":false,"order":1,"body":"","slug":"actions-app-custom-callback-get-one","user":"545383ac08d1800800473d8d","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"name\": \"destroy_death_star\",\n  \"order\": 3,\n  \"params\": {\n    \"lead\": \"Luke Skywalker\",\n    \"commander\": \"Princess Leia\"\n  },\n  \"type\": \"ActionAppCustomCallback\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-app-custom-callback/1/\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-app-custom-callback/:id","auth":"required","method":"get","params":[]},"category":"5517d05cb625a50d001260a8","hidden":false,"link_url":"","project":"545386120c09721000a069f5","childrenPages":[]}

getGet One Action App Custom Callback

Get one action of type app custom callback

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551e974bc2d1ec1700b425d7","type":"post","project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","category":"5517d05cb625a50d001260a8","editedParams":true,"excerpt":"Create an action of type app custom callback","githubsync":"","hidden":false,"link_url":"","version":"54c8b329b3334c0d00236654","__v":1,"createdAt":"2015-04-03T13:36:11.316Z","order":2,"sync_unique":"","title":"Create Action App Custom Callback","updates":[],"api":{"method":"post","params":[{"desc":"Campaign ID","default":"","type":"int","name":"campaign","in":"body","_id":"5517de3c07dedf0d00a3f5b1","required":true},{"type":"int","name":"order","in":"body","_id":"5517de3c07dedf0d00a3f5b2","required":false,"desc":"Position in the stack of actions","default":""},{"_id":"5517dc97b625a50d001260b5","required":false,"desc":"The name of a function registered in the SDK","default":"","type":"string","name":"name","in":"body"},{"_id":"5517dc97b625a50d001260b4","required":false,"desc":"A JSON dictionary like key-word arguments","default":"","type":"object","name":"params","in":"body"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"name\": \"destroy_death_star\",\n  \"order\": 3,\n  \"params\": {\n    \"lead\": \"Luke Skywalker\",\n    \"commander\": \"Princess Leia\"\n  },\n  \"type\": \"ActionAppCustomCallback\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-app-custom-callback/1/\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-app-custom-callback","auth":"required"},"body":"","editedParams2":true,"link_external":false,"slug":"actions-app-custom-callback-create","childrenPages":[]}

postCreate Action App Custom Callback

Create an action of type app custom callback

Body Params

campaign:
required
integer
Campaign ID
order:
integer
Position in the stack of actions
name:
string
The name of a function registered in the SDK
params:
object
A JSON dictionary like key-word arguments

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551e9777a4f7771700ff7ede","api":{"auth":"required","method":"patch","params":[{"required":false,"desc":"Position in the stack of actions","default":"","type":"int","name":"order","in":"body","_id":"5517de3c07dedf0d00a3f5b2"},{"desc":"Campaign ID","name":"campaign","required":false,"type":"int","in":"body","_id":"5517de3c07dedf0d00a3f5b1","default":""},{"default":"","type":"string","name":"name","in":"body","_id":"5517dc97b625a50d001260b5","required":false,"desc":"The name of a function registered in the SDK"},{"in":"body","_id":"5517dc97b625a50d001260b4","required":false,"desc":"A JSON dictionary like key-word arguments","default":"","type":"object","name":"params"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"name\": \"destroy_death_star\",\n  \"order\": 3,\n  \"params\": {\n    \"lead\": \"Luke Skywalker\",\n    \"commander\": \"Princess Leia\"\n  },\n  \"type\": \"ActionAppCustomCallback\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-app-custom-callback/1/\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-app-custom-callback/:id"},"editedParams":true,"link_url":"","user":"545383ac08d1800800473d8d","type":"patch","__v":0,"createdAt":"2015-04-03T13:36:55.855Z","excerpt":"Partial update of an actions of type app custom callback","githubsync":"","link_external":false,"slug":"actions-app-custom-callback-partial-update","sync_unique":"","body":"","editedParams2":true,"hidden":false,"project":"545386120c09721000a069f5","category":"5517d05cb625a50d001260a8","order":3,"title":"Partial Update Action App Custom Callback","updates":[],"version":"54c8b329b3334c0d00236654","childrenPages":[]}

patchPartial Update Action App Custom Callback

Partial update of an actions of type app custom callback

Body Params

order:
integer
Position in the stack of actions
campaign:
integer
Campaign ID
name:
string
The name of a function registered in the SDK
params:
object
A JSON dictionary like key-word arguments

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551e9804c2d1ec1700b425d8","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"put","params":[{"_id":"5517de3c07dedf0d00a3f5b2","required":false,"desc":"Position in the stack of actions","default":"","type":"int","name":"order","in":"body"},{"_id":"5517de3c07dedf0d00a3f5b1","required":false,"desc":"Campaign ID","default":"","type":"int","name":"campaign","in":"body"},{"required":false,"desc":"The name of a function registered in the SDK","default":"","type":"string","name":"name","in":"body","_id":"5517dc97b625a50d001260b5"},{"desc":"A JSON dictionary like key-word arguments","default":"","type":"object","name":"params","in":"body","_id":"5517dc97b625a50d001260b4","required":false}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"name\": \"destroy_death_star\",\n  \"order\": 3,\n  \"params\": {\n    \"lead\": \"Luke Skywalker\",\n    \"commander\": \"Princess Leia\"\n  },\n  \"type\": \"ActionAppCustomCallback\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-app-custom-callback/1/\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-app-custom-callback/:id"},"body":"","link_url":"","project":"545386120c09721000a069f5","sync_unique":"","type":"put","category":"5517d05cb625a50d001260a8","createdAt":"2015-04-03T13:39:16.523Z","editedParams2":true,"excerpt":"Full update of an action of type app custom callback","link_external":false,"slug":"actions-app-custom-callback-update","__v":0,"editedParams":true,"githubsync":"","title":"Update Action App Custom Callback","updates":[],"version":"54c8b329b3334c0d00236654","hidden":false,"order":4,"childrenPages":[]}

putUpdate Action App Custom Callback

Full update of an action of type app custom callback

Body Params

order:
integer
Position in the stack of actions
campaign:
integer
Campaign ID
name:
string
The name of a function registered in the SDK
params:
object
A JSON dictionary like key-word arguments

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551e9ed6c2d1ec1700b425e4","body":"","category":"5517d05cb625a50d001260a8","excerpt":"Get one action of type app custom callback","order":5,"title":"Delete Action App Custom Callback","__v":2,"project":"545386120c09721000a069f5","slug":"actions-app-custom-callback-delete","sync_unique":"","updates":[],"version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"delete","params":[],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-app-custom-callback/:id"},"hidden":false,"type":"delete","createdAt":"2015-04-03T14:08:22.255Z","githubsync":"","link_external":false,"link_url":"","user":"545383ac08d1800800473d8d","childrenPages":[]}

deleteDelete Action App Custom Callback

Get one action of type app custom callback

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"551e9846c2d1ec1700b425d9","project":"545386120c09721000a069f5","slug":"actions-deliver-coupon-get-all","updates":[],"user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"name":"","code":"[\n    {\n        \"campaign\": 185349,\n        \"coupon\": 377336,\n        \"id\": 239,\n        \"order\": null,\n        \"passbook\": \"https://api.movintracks.io/v2.0/webviews/coupons-passbook/377336\",\n        \"type\": \"ActionDeliverCoupon\",\n        \"url\": \"https://api.movintracks.io/v2.0/actions-deliver-coupon/239/\",\n        \"webview\": \"https://api.movintracks.io/v2.0/webviews/coupons/377336\"\n    }\n]","language":"json","status":200},{"status":400,"name":"","code":"{}","language":"json"}]},"url":"/v:version/actions-deliver-coupon"},"excerpt":"Get all actions of type deliver coupon","hidden":false,"link_external":false,"version":"54c8b329b3334c0d00236654","sync_unique":"","title":"Get All Actions Deliver Coupon","category":"5517d063b625a50d001260a9","githubsync":"","order":0,"__v":4,"body":"","type":"get","createdAt":"2015-04-03T13:40:22.060Z","link_url":"","childrenPages":[]}

getGet All Actions Deliver Coupon

Get all actions of type deliver coupon

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551e9a278503071700b3b6ee","category":"5517d063b625a50d001260a9","githubsync":"","order":1,"sync_unique":"","updates":[],"__v":2,"api":{"url":"/v:version/actions-deliver-coupon/:id","auth":"required","method":"get","params":[],"results":{"codes":[{"language":"json","code":"{\n  \"campaign\": 185349,\n  \"coupon\": 377336,\n  \"id\": 239,\n  \"order\": null,\n  \"passbook\": \"https://api.movintracks.io/v2.0/webviews/coupons-passbook/377336\",\n  \"type\": \"ActionDeliverCoupon\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-deliver-coupon/239/\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/coupons/377336\"\n}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]}},"link_url":"","project":"545386120c09721000a069f5","slug":"actions-deliver-coupon-get-one","createdAt":"2015-04-03T13:48:23.732Z","excerpt":"Get one action of type deliver coupon","hidden":false,"link_external":false,"type":"get","body":"","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","title":"Get One Action Deliver Coupon","childrenPages":[]}

getGet One Action Deliver Coupon

Get one action of type deliver coupon

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551e9a82610f400d00837dd7","editedParams2":true,"excerpt":"Get one action of type deliver coupon","githubsync":"","project":"545386120c09721000a069f5","sync_unique":"","version":"54c8b329b3334c0d00236654","category":"5517d063b625a50d001260a9","slug":"actions-deliver-coupon-create","type":"post","user":"545383ac08d1800800473d8d","editedParams":true,"link_external":false,"hidden":false,"link_url":"","order":2,"__v":1,"api":{"method":"post","params":[{"name":"order","in":"body","_id":"5517de3c07dedf0d00a3f5b2","required":false,"desc":"Position in the stack of actions","default":"","type":"int"},{"name":"campaign","in":"body","_id":"5517de3c07dedf0d00a3f5b1","required":true,"desc":"Campaign ID","default":"","type":"int"},{"desc":"Coupon ID","default":"","type":"int","name":"coupon","in":"body","_id":"5517dc97b625a50d001260b5","required":true},{"type":"string","name":"passbook","in":"body","_id":"5517dc97b625a50d001260b4","required":false,"desc":"URL, read only, to download a passbook file","default":""},{"_id":"551e99b1610f400d00837dd6","required":false,"desc":"detail view of an instance","default":"","type":"string","name":"url","in":"body"},{"_id":"551e99b1610f400d00837dd5","required":false,"desc":"URL, read only, to view the passbook file","default":"","type":"string","name":"webview","in":"body"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"campaign\": 185349,\n  \"coupon\": 377336,\n  \"id\": 239,\n  \"order\": null,\n  \"passbook\": \"https://api.movintracks.io/v2.0/webviews/coupons-passbook/377336\",\n  \"type\": \"ActionDeliverCoupon\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-deliver-coupon/239/\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/coupons/377336\"\n}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"url":"/v:version/actions-deliver-coupon","auth":"required"},"title":"Create Action Deliver Coupon","updates":[],"body":"","createdAt":"2015-04-03T13:49:54.020Z","childrenPages":[]}

postCreate Action Deliver Coupon

Get one action of type deliver coupon

Body Params

order:
integer
Position in the stack of actions
campaign:
required
integer
Campaign ID
coupon:
required
integer
Coupon ID
passbook:
string
URL, read only, to download a passbook file
url:
string
detail view of an instance
webview:
string
URL, read only, to view the passbook file

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551e9b1cc2d1ec1700b425dd","category":"5517d063b625a50d001260a9","editedParams":true,"link_external":false,"updates":[],"body":"","githubsync":"","hidden":false,"title":"Partial Update Action Deliver Coupon","type":"patch","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 185349,\n  \"coupon\": 377336,\n  \"id\": 239,\n  \"order\": null,\n  \"passbook\": \"https://api.movintracks.io/v2.0/webviews/coupons-passbook/377336\",\n  \"type\": \"ActionDeliverCoupon\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-deliver-coupon/239/\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/coupons/377336\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-deliver-coupon","auth":"required","method":"patch","params":[{"desc":"Position in the stack of actions","default":"","type":"int","name":"order","in":"body","_id":"5517de3c07dedf0d00a3f5b2","required":false},{"default":"","type":"int","name":"campaign","in":"body","_id":"5517de3c07dedf0d00a3f5b1","required":true,"desc":"Campaign ID"},{"in":"body","_id":"5517dc97b625a50d001260b5","required":true,"desc":"Coupon ID","default":"","type":"int","name":"coupon"},{"type":"string","name":"passbook","in":"body","_id":"5517dc97b625a50d001260b4","required":false,"desc":"URL, read only, to download a passbook file","default":""},{"_id":"551e99b1610f400d00837dd6","required":false,"desc":"detail view of an instance","default":"","type":"string","name":"url","in":"body"},{"_id":"551e99b1610f400d00837dd5","required":false,"desc":"URL, read only, to view the passbook file","default":"","type":"string","name":"webview","in":"body"}]},"excerpt":"Partially update an action of type deliver coupon","link_url":"","sync_unique":"","createdAt":"2015-04-03T13:52:28.300Z","editedParams2":true,"order":3,"project":"545386120c09721000a069f5","slug":"actions-deliver-coupon-partial-update","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","__v":0,"childrenPages":[]}

patchPartial Update Action Deliver Coupon

Partially update an action of type deliver coupon

Body Params

order:
integer
Position in the stack of actions
campaign:
required
integer
Campaign ID
coupon:
required
integer
Coupon ID
passbook:
string
URL, read only, to download a passbook file
url:
string
detail view of an instance
webview:
string
URL, read only, to view the passbook file

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f53ebdf54680d00180400","title":"Update Action Deliver Coupon","editedParams":true,"editedParams2":true,"githubsync":"","link_url":"","project":"545386120c09721000a069f5","slug":"action-deliver-coupon-update","updates":[],"user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","body":"","hidden":false,"type":"put","api":{"auth":"required","method":"put","params":[{"required":false,"desc":"Position in the stack of actions","default":"","type":"int","name":"order","in":"body","_id":"5517de3c07dedf0d00a3f5b2"},{"name":"campaign","in":"body","_id":"5517de3c07dedf0d00a3f5b1","required":true,"desc":"Campaign ID","default":"","type":"int"},{"name":"coupon","in":"body","_id":"5517dc97b625a50d001260b5","required":true,"desc":"Coupon ID","default":"","type":"int"},{"name":"passbook","in":"body","_id":"5517dc97b625a50d001260b4","required":false,"desc":"URL, read only, to download a passbook file","default":"","type":"string"},{"name":"url","in":"body","_id":"551e99b1610f400d00837dd6","required":false,"desc":"detail view of an instance","default":"","type":"string"},{"name":"webview","in":"body","_id":"551e99b1610f400d00837dd5","required":false,"desc":"URL, read only, to view the passbook file","default":"","type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 185349,\n  \"coupon\": 377336,\n  \"id\": 239,\n  \"order\": null,\n  \"passbook\": \"https://api.movintracks.io/v2.0/webviews/coupons-passbook/377336\",\n  \"type\": \"ActionDeliverCoupon\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-deliver-coupon/239/\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/coupons/377336\"\n}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/actions-deliver-coupon"},"link_external":false,"sync_unique":"","__v":0,"category":"5517d063b625a50d001260a9","createdAt":"2015-05-22T16:06:03.425Z","excerpt":"Partially update an action of type deliver coupon","order":4,"childrenPages":[]}

putUpdate Action Deliver Coupon

Partially update an action of type deliver coupon

Body Params

order:
integer
Position in the stack of actions
campaign:
required
integer
Campaign ID
coupon:
required
integer
Coupon ID
passbook:
string
URL, read only, to download a passbook file
url:
string
detail view of an instance
webview:
string
URL, read only, to view the passbook file

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551ea0c2c2d1ec1700b425e6","hidden":false,"order":5,"type":"delete","user":"545383ac08d1800800473d8d","body":"","githubsync":"","project":"545386120c09721000a069f5","sync_unique":"","updates":[],"version":"54c8b329b3334c0d00236654","category":"5517d063b625a50d001260a9","excerpt":"Get all actions of type deliver coupon","slug":"delete-actions-deliver-coupon","title":"Delete Actions Deliver Coupon","__v":1,"createdAt":"2015-04-03T14:16:34.373Z","link_external":false,"link_url":"","api":{"params":[],"results":{"codes":[{"code":"","language":"json","status":204,"name":""},{"language":"json","status":400,"name":"","code":"{}"}]},"url":"/v:version/actions-deliver-coupon/:id","auth":"required","method":"delete"},"childrenPages":[]}

deleteDelete Actions Deliver Coupon

Get all actions of type deliver coupon

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"5523da797a36b22b0088653c","api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 1,\n    \"order\": 0,\n    \"type\": \"ActionDownloadVCard\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-download-vcard/1\",\n    \"url_file\": \"https://api.movintracks.io/v2.0/webviews/vcard-download/1\",\n    \"vcard\": 5\n  }\n]"},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-download-vcard","auth":"required","method":"get","params":[]},"excerpt":"Gets all actions of type Download vCard","order":0,"slug":"actions-download-vcard-get-all","user":"545383ac08d1800800473d8d","githubsync":"","hidden":false,"project":"545386120c09721000a069f5","updates":[],"version":"54c8b329b3334c0d00236654","category":"5517d06b15f7bd170082e4b5","createdAt":"2015-04-07T13:24:09.365Z","link_external":false,"link_url":"","__v":2,"body":"","sync_unique":"","title":"Get All Actions Download vCard","type":"get","childrenPages":[]}

getGet All Actions Download vCard

Gets all actions of type Download vCard

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5523dabc71c054210099347b","hidden":false,"link_external":false,"title":"Get One Action Download vCard","type":"get","updates":[],"createdAt":"2015-04-07T13:25:16.845Z","excerpt":"Gets one action of type Download vCard","user":"545383ac08d1800800473d8d","order":1,"slug":"action-download-vcard-get-one","version":"54c8b329b3334c0d00236654","editedParams2":true,"githubsync":"","project":"545386120c09721000a069f5","sync_unique":"","api":{"auth":"required","method":"get","params":[{"in":"path","_id":"5523dabc71c054210099347c","default":"","desc":"Action Download vCard id","name":"id","required":true,"type":"int"}],"results":{"codes":[{"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionDownloadVCard\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-download-vcard/1\",\n  \"url_file\": \"https://api.movintracks.io/v2.0/webviews/vcard-download/1\",\n  \"vcard\": 5\n}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/v:version/actions-download-vcard/:id"},"category":"5517d06b15f7bd170082e4b5","editedParams":true,"__v":0,"body":"","link_url":"","childrenPages":[]}

getGet One Action Download vCard

Gets one action of type Download vCard

Path Params

id:
required
integer
Action Download vCard id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5523db162813fd230030f692","api":{"auth":"required","method":"post","params":[{"required":true,"desc":"vcard ID","default":"","type":"int","name":"vcard","in":"body","_id":"55b6406dc2e909190073ec0f"},{"name":"campaign","in":"body","_id":"55b6406dc2e909190073ec0e","required":true,"desc":"campaign ID","default":"","type":"int"},{"desc":"position in the stack of actions","default":"","type":"int","name":"order","in":"body","_id":"55b6406dc2e909190073ec0d","required":false}],"results":{"codes":[{"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionDownloadVCard\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-download-vcard/1\",\n  \"url_file\": \"https://api.movintracks.io/v2.0/webviews/vcard-download/1\",\n  \"vcard\": 5\n}","name":"","status":201},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-download-vcard"},"editedParams2":true,"hidden":false,"project":"545386120c09721000a069f5","title":"Create Action Download vCard","user":"545383ac08d1800800473d8d","__v":1,"type":"post","slug":"action-download-vcard-create","category":"5517d06b15f7bd170082e4b5","createdAt":"2015-04-07T13:26:46.872Z","editedParams":true,"link_url":"","order":2,"sync_unique":"","updates":[],"body":"","githubsync":"","link_external":false,"version":"54c8b329b3334c0d00236654","excerpt":"Create action of type Download vCard","childrenPages":[]}

postCreate Action Download vCard

Create action of type Download vCard

Body Params

vcard:
required
integer
vcard ID
campaign:
required
integer
campaign ID
order:
integer
position in the stack of actions

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5523db7371c0542100993481","project":"545386120c09721000a069f5","slug":"action-download-vcard-partial-update","title":"Partial Update Action Download vCard","__v":2,"body":"","api":{"auth":"required","method":"patch","params":[{"_id":"5523dabc71c054210099347c","required":true,"desc":"Action Download vCard id","default":"","type":"int","name":"id","in":"path"},{"_id":"5523dbedd326800d0022444e","required":false,"desc":"Campaign id","default":"","type":"int","name":"campaign","in":"body"},{"required":false,"desc":"","default":"","type":"int","name":"order","in":"body","_id":"5523dbedd326800d0022444d"},{"desc":"vCard id","default":"","type":"int","name":"vcard","in":"body","_id":"5523dbedd326800d00224449","required":false}],"results":{"codes":[{"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionDownloadVCard\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-download-vcard/1\",\n  \"url_file\": \"https://api.movintracks.io/v2.0/webviews/vcard-download/1\",\n  \"vcard\": 5\n}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/v:version/actions-download-vcard/:id"},"link_external":false,"order":3,"type":"patch","updates":[],"category":"5517d06b15f7bd170082e4b5","createdAt":"2015-04-07T13:28:19.671Z","githubsync":"","hidden":false,"link_url":"","sync_unique":"","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","editedParams":true,"editedParams2":true,"excerpt":"Partially updates an action of type Download vCard","childrenPages":[]}

patchPartial Update Action Download vCard

Partially updates an action of type Download vCard

Path Params

id:
required
integer
Action Download vCard id

Body Params

campaign:
integer
Campaign id
order:
integer
vcard:
integer
vCard id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5523dc3271c0542100993482","editedParams2":true,"githubsync":"","link_external":false,"link_url":"","project":"545386120c09721000a069f5","slug":"action-download-vcard-update","sync_unique":"","updates":[],"editedParams":true,"user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"put","params":[{"in":"path","_id":"5523dabc71c054210099347c","required":true,"desc":"Action Download vCard id","default":"","type":"int","name":"id"},{"type":"int","name":"campaign","in":"body","_id":"5523dbedd326800d0022444e","required":true,"desc":"Campaign id","default":""},{"_id":"5523dbedd326800d0022444d","required":false,"desc":"Position in the stack of actions","default":"","type":"int","name":"order","in":"body"},{"in":"body","_id":"5523dbedd326800d00224449","required":true,"desc":"vCard id","default":"","type":"int","name":"vcard"}],"results":{"codes":[{"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionDownloadVCard\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-download-vcard/1\",\n  \"url_file\": \"https://api.movintracks.io/v2.0/webviews/vcard-download/1\",\n  \"vcard\": 5\n}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/v:version/actions-download-vcard/:id"},"category":"5517d06b15f7bd170082e4b5","createdAt":"2015-04-07T13:31:30.536Z","order":4,"body":"","excerpt":"Updates an action of type Download vCard","hidden":false,"title":"Update Action Download vCard","type":"put","version":"54c8b329b3334c0d00236654","__v":1,"childrenPages":[]}

putUpdate Action Download vCard

Updates an action of type Download vCard

Path Params

id:
required
integer
Action Download vCard id

Body Params

campaign:
required
integer
Campaign id
order:
integer
Position in the stack of actions
vcard:
required
integer
vCard id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5523dc651be9763500b286eb","slug":"action-download-vcard-delete","title":"Delete Action Download vCard","user":"545383ac08d1800800473d8d","editedParams":true,"githubsync":"","link_external":false,"sync_unique":"","body":"","createdAt":"2015-04-07T13:32:21.870Z","link_url":"","order":5,"project":"545386120c09721000a069f5","type":"delete","updates":[],"api":{"method":"delete","params":[{"name":"id","in":"path","_id":"5523dabc71c054210099347c","required":true,"desc":"Action Download vCard id","default":"","type":"int"}],"results":{"codes":[{"name":"","status":204,"language":"json","code":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-download-vcard/:id","auth":"required"},"editedParams2":true,"category":"5517d06b15f7bd170082e4b5","excerpt":"Deletes an action of type Download vCard","hidden":false,"version":"54c8b329b3334c0d00236654","__v":0,"childrenPages":[]}

deleteDelete Action Download vCard

Deletes an action of type Download vCard

Path Params

id:
required
integer
Action Download vCard id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"5523dd5d1be9763500b286ec","category":"5517d071f732e32100056eef","githubsync":"","hidden":false,"sync_unique":"","title":"Get All Action Launch App","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 1,\n    \"order\": 0,\n    \"type\": \"ActionLaunchApp\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-launch-app/1\",\n    \"url_android\": \"fb://example\",\n    \"url_fallback\": \"http://movintracks.io\",\n    \"url_ios\": \"fb://example\"\n  }\n]"},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-launch-app"},"link_external":false,"link_url":"","order":0,"slug":"action-launch-app-get-all","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","body":"","createdAt":"2015-04-07T13:36:29.302Z","excerpt":"Gets all actions of type Launch App","type":"get","updates":[],"__v":0,"project":"545386120c09721000a069f5","childrenPages":[]}

getGet All Action Launch App

Gets all actions of type Launch App

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5523dc9171c0542100993485","__v":0,"editedParams":true,"editedParams2":true,"link_external":false,"sync_unique":"","title":"Get One Action Launch App","updates":[],"user":"545383ac08d1800800473d8d","body":"","githubsync":"","order":1,"slug":"action-launch-app-get-one","api":{"auth":"required","method":"get","params":[{"required":true,"type":"int","in":"path","_id":"5523dabc71c054210099347c","default":"","desc":"Action Download vCard id","name":"id"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionLaunchApp\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-launch-app/1\",\n  \"url_android\": \"fb://example\",\n  \"url_fallback\": \"http://movintracks.io\",\n  \"url_ios\": \"fb://example\"\n}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"url":"/v:version/actions-launch-app/:id"},"category":"5517d071f732e32100056eef","excerpt":"Gets one action of type Launch App","hidden":false,"project":"545386120c09721000a069f5","type":"get","createdAt":"2015-04-07T13:33:05.771Z","link_url":"","version":"54c8b329b3334c0d00236654","childrenPages":[]}

getGet One Action Launch App

Gets one action of type Launch App

Path Params

id:
required
integer
Action Download vCard id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"552552389be9a417002b1dcd","body":"","editedParams2":true,"excerpt":"Create actions of type Launch App","hidden":false,"link_url":"","order":2,"type":"post","updates":[],"slug":"actions-launch-app-create","user":"545383ac08d1800800473d8d","githubsync":"","api":{"auth":"required","method":"post","params":[{"in":"body","_id":"552552389be9a417002b1dd0","default":"","desc":"campaign id","name":"campaign","required":true,"type":"int"},{"default":"","type":"string","name":"order","in":"body","_id":"552552389be9a417002b1dcf","required":false,"desc":"Position in the stack of actions"},{"in":"body","_id":"55255363bdcaeb35006698de","required":false,"desc":"URI of the Android activity","default":"","type":"string","name":"url_android"},{"type":"string","name":"url_ios","in":"body","_id":"55255363bdcaeb35006698dd","required":false,"desc":"URI of the iOS app part","default":""},{"_id":"55255363bdcaeb35006698dc","required":false,"desc":"URL of a fallback address, if platform-specific urls don't apply","default":"","type":"string","name":"url_fallback","in":"body"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionLaunchApp\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-launch-app/1\",\n  \"url_android\": \"fb://example\",\n  \"url_fallback\": \"http://movintracks.io\",\n  \"url_ios\": \"fb://example\"\n}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"url":"/v:version/actions-launch-app"},"link_external":false,"title":"Create Action Launch App","__v":1,"createdAt":"2015-04-08T16:07:20.295Z","editedParams":true,"project":"545386120c09721000a069f5","sync_unique":"","version":"54c8b329b3334c0d00236654","category":"5517d071f732e32100056eef","childrenPages":[]}

postCreate Action Launch App

Create actions of type Launch App

Body Params

campaign:
required
integer
campaign id
order:
string
Position in the stack of actions
url_android:
string
URI of the Android activity
url_ios:
string
URI of the iOS app part
url_fallback:
string
URL of a fallback address, if platform-specific urls don't apply

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"552553f99be9a417002b1dd2","body":"","category":"5517d071f732e32100056eef","sync_unique":"","title":"Partial Update Action Launch App","type":"patch","__v":1,"githubsync":"","hidden":false,"project":"545386120c09721000a069f5","editedParams":true,"link_external":false,"link_url":"","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","createdAt":"2015-04-08T16:14:49.547Z","editedParams2":true,"excerpt":"Partially update actions of type Launch App","order":3,"slug":"actions-launch-app-partial-update","updates":[],"api":{"settings":"","url":"/v:version/actions-launch-app/:id","auth":"required","method":"patch","params":[{"_id":"55b640f1c2e909190073ec10","required":true,"desc":"action id","default":"","type":"int","name":"id","in":"path"},{"in":"body","_id":"552552389be9a417002b1dd0","required":false,"desc":"campaign id","default":"","type":"int","name":"campaign"},{"default":"","type":"int","name":"order","in":"body","_id":"552552389be9a417002b1dcf","required":false,"desc":"Position in the stack of actions"},{"in":"body","_id":"55255363bdcaeb35006698de","required":false,"desc":"URI of the Android activity","default":"","type":"string","name":"url_android"},{"required":false,"desc":"URI of the iOS app part","default":"","type":"string","name":"url_ios","in":"body","_id":"55255363bdcaeb35006698dd"},{"desc":"URL of a fallback address, if platform-specific urls don't apply","default":"","type":"string","name":"url_fallback","in":"body","_id":"55255363bdcaeb35006698dc","required":false}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionLaunchApp\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-launch-app/1\",\n  \"url_android\": \"fb://example\",\n  \"url_fallback\": \"http://movintracks.io\",\n  \"url_ios\": \"fb://example\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"childrenPages":[]}

patchPartial Update Action Launch App

Partially update actions of type Launch App

Path Params

id:
required
integer
action id

Body Params

campaign:
integer
campaign id
order:
integer
Position in the stack of actions
url_android:
string
URI of the Android activity
url_ios:
string
URI of the iOS app part
url_fallback:
string
URL of a fallback address, if platform-specific urls don't apply

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55255426acfb2123009d7302","__v":1,"body":"","editedParams2":true,"title":"Update Action Launch App","version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"put","params":[{"required":true,"desc":"action id","default":"","type":"int","name":"id","in":"path","_id":"55b6418e6127b1250036434d"},{"desc":"campaign id","default":"","type":"int","name":"campaign","in":"body","_id":"552552389be9a417002b1dd0","required":true},{"default":"","type":"int","name":"order","in":"body","_id":"552552389be9a417002b1dcf","required":false,"desc":"Position in the stack of actions"},{"in":"body","_id":"55255363bdcaeb35006698de","required":true,"desc":"URI of the Android activity","default":"","type":"string","name":"url_android"},{"type":"string","name":"url_ios","in":"body","_id":"55255363bdcaeb35006698dd","required":true,"desc":"URI of the iOS app part","default":""},{"_id":"55255363bdcaeb35006698dc","required":true,"desc":"URL of a fallback address, if platform-specific urls don't apply","default":"","type":"string","name":"url_fallback","in":"body"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionLaunchApp\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-launch-app/1\",\n  \"url_android\": \"fb://example\",\n  \"url_fallback\": \"http://movintracks.io\",\n  \"url_ios\": \"fb://example\"\n}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/v:version/actions-launch-app/:id"},"category":"5517d071f732e32100056eef","excerpt":"Update actions of type Launch App","link_external":false,"link_url":"","order":4,"project":"545386120c09721000a069f5","sync_unique":"","type":"put","updates":[],"createdAt":"2015-04-08T16:15:34.230Z","githubsync":"","hidden":false,"editedParams":true,"slug":"action-launch-app-update","user":"545383ac08d1800800473d8d","childrenPages":[]}

putUpdate Action Launch App

Update actions of type Launch App

Path Params

id:
required
integer
action id

Body Params

campaign:
required
integer
campaign id
order:
integer
Position in the stack of actions
url_android:
required
string
URI of the Android activity
url_ios:
required
string
URI of the iOS app part
url_fallback:
required
string
URL of a fallback address, if platform-specific urls don't apply

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5525546d3d88fb37002a5acb","editedParams":true,"link_url":"","editedParams2":true,"hidden":false,"slug":"update-action-launch-app","sync_unique":"","body":"","category":"5517d071f732e32100056eef","createdAt":"2015-04-08T16:16:45.396Z","updates":[],"order":5,"project":"545386120c09721000a069f5","title":"Delete Action Launch App","__v":0,"api":{"results":{"codes":[{"code":"","name":"","status":204,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-launch-app/:id","auth":"required","method":"delete","params":[{"_id":"5525546d3d88fb37002a5acc","required":true,"desc":"action id","default":"","type":"int","name":"id","in":"path"}]},"excerpt":"Update actions of type Launch App","githubsync":"","link_external":false,"type":"delete","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","childrenPages":[]}

deleteDelete Action Launch App

Update actions of type Launch App

Path Params

id:
required
integer
action id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"5525629ff966112500116a2f","githubsync":"","sync_unique":"","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 1,\n    \"order\": 0,\n    \"type\": \"ActionPlaySound\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-play-sound/1\",\n    \"url_action\": \"https://soundcloud.com/benhur/fancy-track\"\n  }\n]","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"url":"/v:version/actions-play-sound"},"createdAt":"2015-04-08T17:17:19.699Z","excerpt":"Get all actions of type play sound","slug":"actions-play-sound-get-all","type":"get","category":"5517d07715f7bd170082e4b6","hidden":false,"link_url":"","order":0,"project":"545386120c09721000a069f5","updates":[],"__v":0,"body":"","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","link_external":false,"title":"Get All Action Play Sound","childrenPages":[]}

getGet All Action Play Sound

Get all actions of type play sound

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"552562d2acfb2123009d730e","editedParams2":true,"hidden":false,"link_external":false,"order":1,"project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","__v":0,"body":"","excerpt":"Get one action of type play sound","githubsync":"","updates":[],"sync_unique":"","title":"Get One Action Play Sound","type":"get","api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionPlaySound\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-play-sound/1\",\n  \"url_action\": \"https://soundcloud.com/benhur/fancy-track\"\n}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-play-sound/:id","auth":"required","method":"get","params":[{"required":true,"type":"int","in":"path","_id":"552562d2acfb2123009d730f","default":"","desc":"Action id","name":"id"}]},"category":"5517d07715f7bd170082e4b6","editedParams":true,"link_url":"","slug":"actions-play-sound-get-one","version":"54c8b329b3334c0d00236654","createdAt":"2015-04-08T17:18:10.238Z","childrenPages":[]}

getGet One Action Play Sound

Get one action of type play sound

Path Params

id:
required
integer
Action id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5525657ff966112500116a3c","excerpt":"Create update action of type play sound","hidden":false,"link_external":false,"link_url":"","slug":"actions-play-sound-create","updates":[],"body":"","user":"545383ac08d1800800473d8d","type":"post","createdAt":"2015-04-08T17:29:35.445Z","editedParams":true,"category":"5517d07715f7bd170082e4b6","editedParams2":true,"order":2,"project":"545386120c09721000a069f5","title":"Create Action Play Sound","__v":1,"api":{"results":{"codes":[{"code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionPlaySound\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-play-sound/1\",\n  \"url_action\": \"https://soundcloud.com/benhur/fancy-track\"\n}","name":"","status":201,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-play-sound","auth":"required","method":"post","params":[{"_id":"552563269be9a417002b1de4","required":true,"desc":"campaign id","default":"","type":"int","name":"campaign","in":"body"},{"required":false,"desc":"Position in the stack of actions","default":"","type":"int","name":"order","in":"body","_id":"552563269be9a417002b1de3"},{"desc":"URL to a service like soundcloud","default":"","type":"string","name":"url_action","in":"body","_id":"552563269be9a417002b1de2","required":true}]},"version":"54c8b329b3334c0d00236654","githubsync":"","sync_unique":"","childrenPages":[]}

postCreate Action Play Sound

Create update action of type play sound

Body Params

campaign:
required
integer
campaign id
order:
integer
Position in the stack of actions
url_action:
required
string
URL to a service like soundcloud

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"552563269be9a417002b1de1","user":"545383ac08d1800800473d8d","body":"","category":"5517d07715f7bd170082e4b6","createdAt":"2015-04-08T17:19:34.995Z","order":3,"sync_unique":"","type":"patch","__v":0,"editedParams2":true,"excerpt":"Partial update action of type play sound","hidden":false,"title":"Partial Update Action Play Sound","link_external":false,"slug":"actions-play-sound-partial-update","updates":[],"version":"54c8b329b3334c0d00236654","api":{"method":"patch","params":[{"name":"id","in":"path","_id":"552562d2acfb2123009d730f","required":true,"desc":"Action id","default":"","type":"int"},{"type":"int","in":"body","_id":"552563269be9a417002b1de4","default":"","desc":"campaign id","name":"campaign","required":true},{"desc":"Position in the stack of actions","default":"","type":"int","name":"order","in":"body","_id":"552563269be9a417002b1de3","required":false},{"type":"string","name":"url_action","in":"body","_id":"552563269be9a417002b1de2","required":false,"desc":"URL to a service like soundcloud","default":""}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionPlaySound\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-play-sound/1\",\n  \"url_action\": \"https://soundcloud.com/benhur/fancy-track\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-play-sound/:id","auth":"required"},"editedParams":true,"githubsync":"","link_url":"","project":"545386120c09721000a069f5","childrenPages":[]}

patchPartial Update Action Play Sound

Partial update action of type play sound

Path Params

id:
required
integer
Action id

Body Params

campaign:
required
integer
campaign id
order:
integer
Position in the stack of actions
url_action:
string
URL to a service like soundcloud

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55256522f966112500116a38","githubsync":"","updates":[],"user":"545383ac08d1800800473d8d","body":"","link_url":"","slug":"actions-play-sound-update","sync_unique":"","createdAt":"2015-04-08T17:28:02.388Z","editedParams":true,"editedParams2":true,"excerpt":"Update action of type play sound","project":"545386120c09721000a069f5","__v":0,"api":{"auth":"required","method":"put","params":[{"_id":"552562d2acfb2123009d730f","required":true,"desc":"Action id","default":"","type":"int","name":"id","in":"path"},{"in":"body","_id":"552563269be9a417002b1de4","default":"","desc":"campaign id","name":"campaign","required":true,"type":"int"},{"default":"","type":"int","name":"order","in":"body","_id":"552563269be9a417002b1de3","required":false,"desc":"Position in the stack of actions"},{"in":"body","_id":"552563269be9a417002b1de2","default":"","desc":"URL to a service like soundcloud","name":"url_action","required":true,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionPlaySound\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-play-sound/1\",\n  \"url_action\": \"https://soundcloud.com/benhur/fancy-track\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-play-sound/:id"},"category":"5517d07715f7bd170082e4b6","hidden":false,"link_external":false,"order":4,"title":"Update Action Play Sound","type":"put","version":"54c8b329b3334c0d00236654","childrenPages":[]}

putUpdate Action Play Sound

Update action of type play sound

Path Params

id:
required
integer
Action id

Body Params

campaign:
required
integer
campaign id
order:
integer
Position in the stack of actions
url_action:
required
string
URL to a service like soundcloud

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"552565543d88fb37002a5ae7","__v":0,"user":"545383ac08d1800800473d8d","category":"5517d07715f7bd170082e4b6","editedParams":true,"excerpt":"Delete action of type play sound","link_external":false,"link_url":"","sync_unique":"","title":"Delete Action Play Sound","api":{"method":"delete","params":[{"name":"id","in":"path","_id":"552562d2acfb2123009d730f","required":true,"desc":"Action id","default":"","type":"int"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-play-sound/:id","auth":"required"},"editedParams2":true,"githubsync":"","project":"545386120c09721000a069f5","slug":"actions-play-sound-delete","type":"delete","body":"","createdAt":"2015-04-08T17:28:52.363Z","hidden":false,"order":5,"updates":[],"version":"54c8b329b3334c0d00236654","childrenPages":[]}

deleteDelete Action Play Sound

Delete action of type play sound

Path Params

id:
required
integer
Action id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"5525662c3d88fb37002a5ae8","githubsync":"","hidden":false,"order":0,"user":"545383ac08d1800800473d8d","category":"5517d07d07dedf0d00a3f5a9","type":"get","updates":[],"link_url":"","link_external":false,"project":"545386120c09721000a069f5","slug":"actions-play-video-get-all","version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 1,\n    \"order\": 0,\n    \"type\": \"ActionPlayVideo\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-play-video/1\",\n    \"url_action\": \"https://www.youtube.com/watch?v=VIDEOID123\"\n  }\n]"},{"language":"json","code":"{}","name":"","status":400}]},"url":"/v:version/actions-play-video"},"body":"","createdAt":"2015-04-08T17:32:28.812Z","excerpt":"Get all actions of type play video","sync_unique":"","title":"Get All Action Play Video","__v":0,"childrenPages":[]}

getGet All Action Play Video

Get all actions of type play video

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5525665117b36d0d0040dfbc","title":"Get One Action Play Video","excerpt":"Get one action of type play video","link_url":"","sync_unique":"","editedParams":true,"link_external":false,"project":"545386120c09721000a069f5","type":"get","updates":[],"body":"","createdAt":"2015-04-08T17:33:05.582Z","editedParams2":true,"githubsync":"","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","order":1,"slug":"get-one-action-play-video","__v":0,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionPlayVideo\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-play-video/1\",\n  \"url_action\": \"https://www.youtube.com/watch?v=VIDEOID123\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-play-video/:id","auth":"required","method":"get","params":[{"type":"int","in":"path","_id":"5525665117b36d0d0040dfbd","default":"","desc":"action id","name":"id","required":true}]},"category":"5517d07d07dedf0d00a3f5a9","hidden":false,"childrenPages":[]}

getGet One Action Play Video

Get one action of type play video

Path Params

id:
required
integer
action id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5525667ef966112500116a40","excerpt":"Create update action of type play video","hidden":false,"link_external":false,"order":2,"sync_unique":"","type":"post","__v":1,"githubsync":"","slug":"create-action-play-video","title":"Create Action Play Video","updates":[],"category":"5517d07d07dedf0d00a3f5a9","editedParams":true,"editedParams2":true,"link_url":"","version":"54c8b329b3334c0d00236654","createdAt":"2015-04-08T17:33:50.683Z","api":{"method":"post","params":[{"desc":"campaign id","default":"","type":"int","name":"campaign","in":"body","_id":"552563269be9a417002b1de4","required":true},{"default":"","type":"int","name":"order","in":"body","_id":"552563269be9a417002b1de3","required":false,"desc":"Position in the stack of actions"},{"default":"","desc":"URL to a service like youtube or vimeo","name":"url_action","required":true,"type":"string","in":"body","_id":"552563269be9a417002b1de2"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionPlayVideo\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-play-video/1\",\n  \"url_action\": \"https://www.youtube.com/watch?v=VIDEOID123\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-play-video","auth":"required"},"body":"","project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","childrenPages":[]}

postCreate Action Play Video

Create update action of type play video

Body Params

campaign:
required
integer
campaign id
order:
integer
Position in the stack of actions
url_action:
required
string
URL to a service like youtube or vimeo

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"552566cbf966112500116a41","link_url":"","order":3,"project":"545386120c09721000a069f5","title":"Partial Update Action Play Video","updates":[],"body":"","createdAt":"2015-04-08T17:35:07.342Z","githubsync":"","hidden":false,"user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","__v":0,"editedParams":true,"excerpt":"Partial update action of type play video","slug":"actions-play-video-partial-update","api":{"auth":"required","method":"patch","params":[{"desc":"Action id","default":"","type":"int","name":"id","in":"path","_id":"552562d2acfb2123009d730f","required":true},{"type":"int","name":"campaign","in":"body","_id":"552563269be9a417002b1de4","required":false,"desc":"campaign id","default":""},{"_id":"552563269be9a417002b1de3","required":false,"desc":"Position in the stack of actions","default":"","type":"int","name":"order","in":"body"},{"_id":"552563269be9a417002b1de2","required":false,"desc":"URL to a service like youtube or vimeo","default":"","type":"string","name":"url_action","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionPlayVideo\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-play-video/1\",\n  \"url_action\": \"https://www.youtube.com/watch?v=VIDEOID123\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-play-video/:id"},"category":"5517d07d07dedf0d00a3f5a9","editedParams2":true,"link_external":false,"sync_unique":"","type":"patch","childrenPages":[]}

patchPartial Update Action Play Video

Partial update action of type play video

Path Params

id:
required
integer
Action id

Body Params

campaign:
integer
campaign id
order:
integer
Position in the stack of actions
url_action:
string
URL to a service like youtube or vimeo

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"552567019be9a417002b1df1","category":"5517d07d07dedf0d00a3f5a9","excerpt":"Update action of type play video","sync_unique":"","title":"Update Action Play Video","type":"put","__v":0,"editedParams":true,"link_external":false,"link_url":"","order":4,"updates":[],"body":"","createdAt":"2015-04-08T17:36:01.563Z","api":{"settings":"","url":"/v:version/actions-play-video/:id","auth":"required","method":"put","params":[{"_id":"552562d2acfb2123009d730f","required":true,"desc":"Action id","default":"","type":"int","name":"id","in":"path"},{"in":"body","_id":"552563269be9a417002b1de4","default":"","desc":"campaign id","name":"campaign","required":true,"type":"int"},{"type":"int","name":"order","in":"body","_id":"552563269be9a417002b1de3","required":false,"desc":"Position in the stack of actions","default":""},{"_id":"552563269be9a417002b1de2","default":"","desc":"URL to a service like youtube or vimeo","name":"url_action","required":true,"type":"string","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionPlayVideo\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-play-video/1\",\n  \"url_action\": \"https://www.youtube.com/watch?v=VIDEOID123\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"hidden":false,"project":"545386120c09721000a069f5","slug":"actions-play-video-update","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","editedParams2":true,"githubsync":"","childrenPages":[]}

putUpdate Action Play Video

Update action of type play video

Path Params

id:
required
integer
Action id

Body Params

campaign:
required
integer
campaign id
order:
integer
Position in the stack of actions
url_action:
required
string
URL to a service like youtube or vimeo

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5525671bacfb2123009d7314","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"delete","params":[{"_id":"552562d2acfb2123009d730f","required":true,"desc":"Action id","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-play-video/:id"},"body":"","category":"5517d07d07dedf0d00a3f5a9","createdAt":"2015-04-08T17:36:27.730Z","githubsync":"","type":"delete","editedParams":true,"link_external":false,"slug":"actions-play-video-delete","title":"Delete Action Play Video","editedParams2":true,"excerpt":"Delete action of type play video","hidden":false,"link_url":"","sync_unique":"","version":"54c8b329b3334c0d00236654","__v":0,"order":5,"project":"545386120c09721000a069f5","updates":[],"childrenPages":[]}

deleteDelete Action Play Video

Delete action of type play video

Path Params

id:
required
integer
Action id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"55b74b1a568be2230092b9ad","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"campaign\":1,\n    \"type\":\"ActionSCActivity\",\n    \"id\":1,\n    \"callback\":\"https://api.movintracks.io/v2.0/callbacks/oracle/sales-cloud-create-activity/1\",\n    \"order\":0,\n    \"url\":\"https://api.movintracks.io/v2.0/actions-oracle-sales-cloud-create-activity/1\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/:version/actions-oracle-sales-cloud-create-activity"},"body":"","hidden":false,"link_url":"","sync_unique":"","title":"Get All Actions Oracle Sales Cloud Activity","user":"545383ac08d1800800473d8d","category":"55b749382764c20d008d7d28","excerpt":"","project":"545386120c09721000a069f5","slug":"actions-oracle-sales-cloud-activity-get-all","type":"get","version":"54c8b329b3334c0d00236654","order":0,"updates":[],"__v":1,"createdAt":"2015-07-28T09:27:54.928Z","githubsync":"","link_external":false,"childrenPages":[]}

getGet All Actions Oracle Sales Cloud Activity


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b74c1231bccb190081bedf","category":"55b749382764c20d008d7d28","createdAt":"2015-07-28T09:32:02.884Z","sync_unique":"","link_url":"","slug":"actions-oracle-sales-cloud-activity-get-one","title":"Get One Action Oracle Sales Cloud Activity","updates":[],"__v":0,"body":"","editedParams":true,"link_external":false,"type":"get","editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"version":"54c8b329b3334c0d00236654","api":{"url":"/:version/actions-oracle-sales-cloud-create-activity/:id","auth":"required","method":"get","params":[{"name":"id","in":"path","_id":"55b74c1231bccb190081bee0","required":true,"desc":"action id","default":"","type":"int"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"campaign\":1,\n  \"type\":\"ActionSCActivity\",\n  \"id\":1,\n  \"callback\":\"https://api.movintracks.io/v2.0/callbacks/oracle/sales-cloud-create-activity/1\",\n  \"order\":0,\n  \"url\":\"https://api.movintracks.io/v2.0/actions-oracle-sales-cloud-create-activity/1\"\n}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"order":1,"project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","childrenPages":[]}

getGet One Action Oracle Sales Cloud Activity


Path Params

id:
required
integer
action id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b74c5a31bccb190081bee3","api":{"auth":"required","method":"post","params":[{"default":"","type":"int","name":"campaign","in":"body","_id":"55b74c5a31bccb190081bee5","required":true,"desc":"Campaign ID"},{"required":false,"desc":"Position in the stack of actions","default":"","type":"int","name":"order","in":"body","_id":"55b74c5a31bccb190081bee4"}],"results":{"codes":[{"name":"","status":201,"language":"json","code":"{\n  \"campaign\":1,\n  \"type\":\"ActionSCActivity\",\n  \"id\":1,\n  \"callback\":\"https://api.movintracks.io/v2.0/callbacks/oracle/sales-cloud-create-activity/1\",\n  \"order\":0,\n  \"url\":\"https://api.movintracks.io/v2.0/actions-oracle-sales-cloud-create-activity/1\"\n}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/:version/actions-oracle-sales-cloud-create-activity"},"body":"","excerpt":"","order":2,"sync_unique":"","category":"55b749382764c20d008d7d28","editedParams":true,"link_url":"","githubsync":"","project":"545386120c09721000a069f5","slug":"actions-oracle-sales-cloud-activity-create","title":"Create Actions Oracle Sales Cloud Activity","type":"post","version":"54c8b329b3334c0d00236654","__v":0,"createdAt":"2015-07-28T09:33:14.286Z","editedParams2":true,"hidden":false,"link_external":false,"updates":[],"user":"545383ac08d1800800473d8d","childrenPages":[]}

postCreate Actions Oracle Sales Cloud Activity


Body Params

campaign:
required
integer
Campaign ID
order:
integer
Position in the stack of actions

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b74cb22764c20d008d7d3c","slug":"actions-oracle-sales-cloud-activity-partial-update","title":"Partial Update Actions Oracle Sales Cloud Activity","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\":1,\n  \"type\":\"ActionSCActivity\",\n  \"id\":1,\n  \"callback\":\"https://api.movintracks.io/v2.0/callbacks/oracle/sales-cloud-create-activity/1\",\n  \"order\":0,\n  \"url\":\"https://api.movintracks.io/v2.0/actions-oracle-sales-cloud-create-activity/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/:version/actions-oracle-sales-cloud-create-activity/:id","auth":"required","method":"patch","params":[{"in":"path","_id":"55b74cb22764c20d008d7d3d","required":true,"desc":"Action ID","default":"","type":"int","name":"id"},{"type":"int","name":"campaign","in":"body","_id":"55b74c5a31bccb190081bee5","required":false,"desc":"Campaign ID","default":""},{"_id":"55b74c5a31bccb190081bee4","required":false,"desc":"Position in the stack of actions","default":"","type":"int","name":"order","in":"body"}]},"body":"","excerpt":"","link_url":"","createdAt":"2015-07-28T09:34:42.153Z","link_external":false,"updates":[],"order":3,"project":"545386120c09721000a069f5","sync_unique":"","type":"patch","__v":0,"editedParams":true,"editedParams2":true,"githubsync":"","version":"54c8b329b3334c0d00236654","category":"55b749382764c20d008d7d28","hidden":false,"user":"545383ac08d1800800473d8d","childrenPages":[]}

patchPartial Update Actions Oracle Sales Cloud Activity


Path Params

id:
required
integer
Action ID

Body Params

campaign:
integer
Campaign ID
order:
integer
Position in the stack of actions

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b74cd031bccb190081beee","hidden":false,"project":"545386120c09721000a069f5","body":"","excerpt":"","order":4,"slug":"actions-oracle-sales-cloud-activity-update","user":"545383ac08d1800800473d8d","__v":0,"api":{"params":[{"type":"int","name":"id","in":"path","_id":"55b74cb22764c20d008d7d3d","required":true,"desc":"Action ID","default":""},{"_id":"55b74c5a31bccb190081bee5","required":true,"desc":"Campaign ID","default":"","type":"int","name":"campaign","in":"body"},{"required":false,"desc":"Position in the stack of actions","default":"","type":"int","name":"order","in":"body","_id":"55b74c5a31bccb190081bee4"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"campaign\":1,\n  \"type\":\"ActionSCActivity\",\n  \"id\":1,\n  \"callback\":\"https://api.movintracks.io/v2.0/callbacks/oracle/sales-cloud-create-activity/1\",\n  \"order\":0,\n  \"url\":\"https://api.movintracks.io/v2.0/actions-oracle-sales-cloud-create-activity/1\"\n}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/:version/actions-oracle-sales-cloud-create-activity/:id","auth":"required","method":"put"},"editedParams":true,"githubsync":"","link_external":false,"link_url":"","sync_unique":"","title":"Update Actions Oracle Sales Cloud Activity","type":"put","updates":[],"category":"55b749382764c20d008d7d28","createdAt":"2015-07-28T09:35:12.920Z","editedParams2":true,"version":"54c8b329b3334c0d00236654","childrenPages":[]}

putUpdate Actions Oracle Sales Cloud Activity


Path Params

id:
required
integer
Action ID

Body Params

campaign:
required
integer
Campaign ID
order:
integer
Position in the stack of actions

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b74cea568be2230092b9b4","api":{"url":"/:version/actions-oracle-sales-cloud-create-activity/:id","auth":"required","method":"delete","params":[{"name":"id","in":"path","_id":"55b74cb22764c20d008d7d3d","required":true,"desc":"Action ID","default":"","type":"int"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"createdAt":"2015-07-28T09:35:38.737Z","editedParams2":true,"hidden":false,"version":"54c8b329b3334c0d00236654","__v":0,"githubsync":"","link_url":"","order":5,"sync_unique":"","updates":[],"body":"","category":"55b749382764c20d008d7d28","excerpt":"","link_external":false,"title":"Delete Actions Oracle Sales Cloud Activity","user":"545383ac08d1800800473d8d","editedParams":true,"project":"545386120c09721000a069f5","slug":"actions-oracle-sales-cloud-activity-delete","type":"delete","childrenPages":[]}

deleteDelete Actions Oracle Sales Cloud Activity


Path Params

id:
required
integer
Action ID

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"552572ddf162440d005df195","category":"5517d08115f7bd170082e4b7","link_external":false,"type":"get","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","body":"","hidden":false,"updates":[],"__v":1,"githubsync":"","link_url":"","project":"545386120c09721000a069f5","slug":"actions-show-image-get-all","title":"Get All Action Show Image","api":{"url":"/v:version/actions-show-image","auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 1,\n    \"img_url\": \"https://movintracks-prod.s3.amazonaws.com/media/3c5753d4c0a.png\",\n    \"order\": 0,\n    \"text\": \"Ceci n'est pas une pipe\",\n    \"type\": \"ActionShowImage\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-show-image/1\",\n    \"url_action\": \"http://www.example.org\",\n    \"webview\": \"https://api.movintracks.io/v2.0/webviews/images/1\"\n  }\n]","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":""},"createdAt":"2015-04-08T18:26:37.271Z","excerpt":"Get all actions of type show image","order":0,"sync_unique":"","childrenPages":[]}

getGet All Action Show Image

Get all actions of type show image

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b643e9c2e909190073ec19","__v":0,"api":{"auth":"required","method":"get","params":[{"type":"int","name":"id","in":"path","_id":"55b643e9c2e909190073ec1a","required":true,"desc":"action id","default":""}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"img_url\": \"https://movintracks-prod.s3.amazonaws.com/media/3c5753d4c0a.png\",\n  \"order\": 0,\n  \"text\": \"Ceci n'est pas une pipe\",\n  \"type\": \"ActionShowImage\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-show-image/1\",\n  \"url_action\": \"http://www.example.org\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/images/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-show-image/:id"},"category":"5517d08115f7bd170082e4b7","excerpt":"Get one action of type show image","updates":[],"user":"545383ac08d1800800473d8d","hidden":false,"link_url":"","order":1,"sync_unique":"","version":"54c8b329b3334c0d00236654","createdAt":"2015-07-27T14:44:57.064Z","editedParams2":true,"link_external":false,"title":"Get One Action Show Image","type":"get","body":"","editedParams":true,"githubsync":"","project":"545386120c09721000a069f5","slug":"action-show-image-get-one","childrenPages":[]}

getGet One Action Show Image

Get one action of type show image

Path Params

id:
required
integer
action id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f547b750e240d00cc31b7","api":{"auth":"required","method":"post","params":[{"default":"","type":"int","name":"campaign","in":"body","_id":"555f547b750e240d00cc31bb","required":true,"desc":"campaign id"},{"in":"body","_id":"555f547b750e240d00cc31ba","default":"","desc":"Position in the stack of actions","name":"order","required":false,"type":"int"},{"type":"string","name":"text","in":"body","_id":"555f547b750e240d00cc31b9","required":true,"desc":"","default":""},{"_id":"555f547b750e240d00cc31b8","required":true,"desc":"A URL","default":"","type":"string","name":"url_action","in":"body"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"img_url\": \"\",\n  \"order\": 0,\n  \"text\": \"Ceci n'est pas une pipe\",\n  \"type\": \"ActionShowImage\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-show-image/1\",\n  \"url_action\": \"http://www.example.org\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/images/1\"\n}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/v:version/actions-show-image"},"editedParams":true,"project":"545386120c09721000a069f5","updates":[],"body":"","hidden":false,"order":2,"user":"545383ac08d1800800473d8d","type":"post","version":"54c8b329b3334c0d00236654","__v":0,"category":"5517d08115f7bd170082e4b7","createdAt":"2015-05-22T16:08:27.928Z","excerpt":"Create actions of type show image","link_external":false,"link_url":"","editedParams2":true,"githubsync":"","slug":"action-show-image-create","sync_unique":"","title":"Create Action Show Image","childrenPages":[]}

postCreate Action Show Image

Create actions of type show image

Body Params

campaign:
required
integer
campaign id
order:
integer
Position in the stack of actions
text:
required
string
url_action:
required
string
A URL

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55257454f162440d005df199","githubsync":"","hidden":false,"link_url":"","slug":"actions-show-image-pic-upload","sync_unique":"","body":"Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http -f POST https://api.movintracks.io/v2.0/actions-show-image/1/pic_upload \\\"Authorization: Bearer ...\\\" img@user_logo.png\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","editedParams2":true,"editedParams":true,"excerpt":"Uploads a picture for an action of type show image","type":"post","category":"5517d08115f7bd170082e4b7","createdAt":"2015-04-08T18:32:52.200Z","title":"Upload Picture for Action Show Image","version":"54c8b329b3334c0d00236654","__v":0,"api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"status\": \"Image uploaded successfully.\",\n  \"url\": \"https://movintracks-prod.s3.amazonaws.com/media/123.png\"\n}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/v:version/actions-show-image/:id/pic_upload","auth":"required","method":"post","params":[{"type":"int","in":"path","_id":"55257454f162440d005df19a","default":"","desc":"Action id","name":"id","required":true}]},"order":3,"project":"545386120c09721000a069f5","updates":[],"user":"545383ac08d1800800473d8d","link_external":false,"childrenPages":[]}

postUpload Picture for Action Show Image

Uploads a picture for an action of type show image

Path Params

id:
required
integer
Action id
Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms). [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/v2.0/actions-show-image/1/pic_upload \"Authorization: Bearer ...\" img@user_logo.png", "language": "shell" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms). [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/v2.0/actions-show-image/1/pic_upload \"Authorization: Bearer ...\" img@user_logo.png", "language": "shell" } ] } [/block]
{"_id":"555f54dadf54680d00180404","githubsync":"","updates":[],"version":"54c8b329b3334c0d00236654","hidden":false,"link_external":false,"slug":"action-show-image-update","sync_unique":"","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"put","params":[{"default":"","type":"int","name":"id","in":"path","_id":"555f54dadf54680d00180405","required":true,"desc":"action show image id"},{"required":true,"desc":"campaign id","default":"","type":"int","name":"campaign","in":"body","_id":"555f547b750e240d00cc31bb"},{"type":"int","in":"body","_id":"555f547b750e240d00cc31ba","default":"","desc":"Position in the stack of actions","name":"order","required":false},{"name":"text","in":"body","_id":"555f547b750e240d00cc31b9","required":true,"desc":"","default":"","type":"string"},{"name":"url_action","in":"body","_id":"555f547b750e240d00cc31b8","required":true,"desc":"A URL","default":"","type":"string"}],"results":{"codes":[{"code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"img_url\": \"\",\n  \"order\": 0,\n  \"text\": \"Ceci n'est pas une pipe\",\n  \"type\": \"ActionShowImage\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-show-image/1\",\n  \"url_action\": \"http://www.example.org\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/images/1\"\n}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"/v:version/actions-show-image/:id"},"editedParams":true,"excerpt":"Update actions of type show image","order":4,"project":"545386120c09721000a069f5","title":"Update Action Show Image","type":"put","__v":0,"body":"","category":"5517d08115f7bd170082e4b7","createdAt":"2015-05-22T16:10:02.338Z","editedParams2":true,"link_url":"","childrenPages":[]}

putUpdate Action Show Image

Update actions of type show image

Path Params

id:
required
integer
action show image id

Body Params

campaign:
required
integer
campaign id
order:
integer
Position in the stack of actions
text:
required
string
url_action:
required
string
A URL

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f5504df54680d00180406","editedParams":true,"editedParams2":true,"title":"Partial Update Action Show Image","__v":0,"githubsync":"","order":5,"sync_unique":"","link_external":false,"updates":[],"user":"545383ac08d1800800473d8d","api":{"url":"/v:version/actions-show-image/:id","auth":"required","method":"patch","params":[{"_id":"555f54dadf54680d00180405","required":true,"desc":"action show image id","default":"","type":"int","name":"id","in":"path"},{"in":"body","_id":"555f547b750e240d00cc31bb","required":false,"desc":"campaign id","default":"","type":"int","name":"campaign"},{"type":"int","name":"order","in":"body","_id":"555f547b750e240d00cc31ba","required":false,"desc":"Position in the stack of actions","default":""},{"_id":"555f547b750e240d00cc31b9","required":false,"desc":"","default":"","type":"string","name":"text","in":"body"},{"required":false,"desc":"A URL","default":"","type":"string","name":"url_action","in":"body","_id":"555f547b750e240d00cc31b8"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"img_url\": \"\",\n  \"order\": 0,\n  \"text\": \"Ceci n'est pas une pipe\",\n  \"type\": \"ActionShowImage\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-show-image/1\",\n  \"url_action\": \"http://www.example.org\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/images/1\"\n}"},{"language":"json","code":"{}","name":"","status":400}]}},"body":"","category":"5517d08115f7bd170082e4b7","createdAt":"2015-05-22T16:10:44.457Z","hidden":false,"version":"54c8b329b3334c0d00236654","excerpt":"Partially update actions of type play show image","link_url":"","project":"545386120c09721000a069f5","slug":"update-action-show-image-partial","type":"patch","childrenPages":[]}

patchPartial Update Action Show Image

Partially update actions of type play show image

Path Params

id:
required
integer
action show image id

Body Params

campaign:
integer
campaign id
order:
integer
Position in the stack of actions
text:
string
url_action:
string
A URL

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f553c57fe0a0d00c8f4b4","link_external":false,"type":"delete","body":"","category":"5517d08115f7bd170082e4b7","editedParams2":true,"title":"Delete Action Show Image","user":"545383ac08d1800800473d8d","api":{"results":{"codes":[{"code":"","name":"","status":204,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"url":"/v:version/actions-show-image/:id","auth":"required","method":"delete","params":[{"in":"path","_id":"555f54dadf54680d00180405","required":true,"desc":"action show image id","default":"","type":"int","name":"id"}]},"link_url":"","order":6,"slug":"action-show-image-delete","version":"54c8b329b3334c0d00236654","excerpt":"Delete actions of type play show image","githubsync":"","sync_unique":"","updates":[],"project":"545386120c09721000a069f5","__v":0,"createdAt":"2015-05-22T16:11:40.029Z","editedParams":true,"hidden":false,"childrenPages":[]}

deleteDelete Action Show Image

Delete actions of type play show image

Path Params

id:
required
integer
action show image id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"5525737d58aa012100cefbd0","slug":"actions-show-message","sync_unique":"","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"body\": \"Surprise! This system works!\",\n    \"campaign\": 1,\n    \"id\": 1,\n    \"order\": 0,\n    \"title\": \"Hello World\",\n    \"type\": \"ActionShowMessage\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-show-message/1\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-show-message"},"title":"Get All Action Show Message","user":"545383ac08d1800800473d8d","hidden":false,"link_external":false,"createdAt":"2015-04-08T18:29:17.698Z","project":"545386120c09721000a069f5","type":"get","updates":[],"version":"54c8b329b3334c0d00236654","__v":1,"body":"","githubsync":"","link_url":"","order":0,"category":"5517d087b625a50d001260aa","excerpt":"Get all actions of type show message","childrenPages":[]}

getGet All Action Show Message

Get all actions of type show message

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b64427c2e909190073ec1b","title":"Get One Action Show Message","user":"545383ac08d1800800473d8d","category":"5517d087b625a50d001260aa","editedParams2":true,"excerpt":"Get all actions of type show message","githubsync":"","order":1,"type":"get","__v":0,"link_external":false,"link_url":"","sync_unique":"","version":"54c8b329b3334c0d00236654","body":"","createdAt":"2015-07-27T14:45:59.020Z","editedParams":true,"hidden":false,"api":{"auth":"required","method":"get","params":[{"default":"","type":"int","name":"id","in":"path","_id":"55b64427c2e909190073ec1c","required":true,"desc":"action id"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"body\": \"Surprise! This system works!\",\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"title\": \"Hello World\",\n  \"type\": \"ActionShowMessage\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-show-message/1\"\n}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-show-message/:id"},"project":"545386120c09721000a069f5","slug":"get-one-action-show-message","updates":[],"childrenPages":[]}

getGet One Action Show Message

Get all actions of type show message

Path Params

id:
required
integer
action id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f00c657fe0a0d00c8f3c2","editedParams2":true,"githubsync":"","order":2,"project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","__v":0,"api":{"params":[{"name":"campaign","required":true,"type":"int","in":"body","_id":"555f00c657fe0a0d00c8f3c6","default":"","desc":"campaign ID"},{"in":"body","_id":"555f00c657fe0a0d00c8f3c5","required":true,"desc":"","default":"","type":"string","name":"title"},{"default":"","type":"string","name":"body","in":"body","_id":"555f00c657fe0a0d00c8f3c4","required":true,"desc":""},{"in":"body","_id":"555f00c657fe0a0d00c8f3c3","default":"","desc":"Position in the stack of actions","name":"order","required":false,"type":"int"}],"results":{"codes":[{"language":"json","code":"[\n  {\n    \"body\": \"Surprise! This system works!\",\n    \"campaign\": 1,\n    \"id\": 1,\n    \"order\": 0,\n    \"title\": \"Hello World\",\n    \"type\": \"ActionShowMessage\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-show-message/1\"\n  }\n]","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-show-message","auth":"required","method":"post"},"createdAt":"2015-05-22T10:11:18.425Z","editedParams":true,"hidden":false,"excerpt":"Create an action of type show message","link_external":false,"link_url":"","slug":"create-action-show-message","sync_unique":"","body":"","category":"5517d087b625a50d001260aa","title":"Create Action Show Message","version":"54c8b329b3334c0d00236654","type":"post","updates":[],"childrenPages":[]}

postCreate Action Show Message

Create an action of type show message

Body Params

campaign:
required
integer
campaign ID
title:
required
string
body:
required
string
order:
integer
Position in the stack of actions

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b63de4f8105a2f00c34e3c","slug":"partial-update-action-show-message","title":"Partial Update Action Show Message","type":"patch","__v":0,"excerpt":"Partially update an action of type show message","link_external":false,"api":{"auth":"required","method":"patch","params":[{"required":true,"desc":"Action ID","default":"","type":"int","name":"id","in":"path","_id":"55b63de4f8105a2f00c34e3d"},{"type":"int","in":"body","_id":"555f00c657fe0a0d00c8f3c6","default":"","desc":"Campaign ID","name":"campaign","required":true},{"desc":"","default":"","type":"string","name":"title","in":"body","_id":"555f00c657fe0a0d00c8f3c5","required":true},{"type":"string","name":"body","in":"body","_id":"555f00c657fe0a0d00c8f3c4","required":true,"desc":"","default":""},{"_id":"555f00c657fe0a0d00c8f3c3","default":"","desc":"Position in the stack of actions","name":"order","required":false,"type":"int","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"body\": \"Surprise! This system works!\",\n    \"campaign\": 1,\n    \"id\": 1,\n    \"order\": 0,\n    \"title\": \"Hello World\",\n    \"type\": \"ActionShowMessage\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-show-message/1\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-show-message/:id"},"editedParams2":true,"updates":[],"user":"545383ac08d1800800473d8d","githubsync":"","project":"545386120c09721000a069f5","hidden":false,"link_url":"","order":3,"sync_unique":"","body":"","category":"5517d087b625a50d001260aa","createdAt":"2015-07-27T14:19:16.695Z","editedParams":true,"version":"54c8b329b3334c0d00236654","childrenPages":[]}

patchPartial Update Action Show Message

Partially update an action of type show message

Path Params

id:
required
integer
Action ID

Body Params

campaign:
required
integer
Campaign ID
title:
required
string
body:
required
string
order:
integer
Position in the stack of actions

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b63df6f8105a2f00c34e3e","excerpt":"Updates an action of type show message","githubsync":"","project":"545386120c09721000a069f5","updates":[],"version":"54c8b329b3334c0d00236654","api":{"settings":"","url":"/v:version/actions-show-message/:id","auth":"required","method":"put","params":[{"_id":"55b63de4f8105a2f00c34e3d","required":true,"desc":"Action ID","default":"","type":"int","name":"id","in":"path"},{"in":"body","_id":"555f00c657fe0a0d00c8f3c6","default":"","desc":"Campaign ID","name":"campaign","required":true,"type":"int"},{"type":"string","name":"title","in":"body","_id":"555f00c657fe0a0d00c8f3c5","required":true,"desc":"","default":""},{"_id":"555f00c657fe0a0d00c8f3c4","required":true,"desc":"","default":"","type":"string","name":"body","in":"body"},{"_id":"555f00c657fe0a0d00c8f3c3","default":"","desc":"Position in the stack of actions","name":"order","required":false,"type":"int","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"body\": \"Surprise! This system works!\",\n    \"campaign\": 1,\n    \"id\": 1,\n    \"order\": 0,\n    \"title\": \"Hello World\",\n    \"type\": \"ActionShowMessage\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-show-message/1\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"editedParams":true,"type":"put","user":"545383ac08d1800800473d8d","editedParams2":true,"link_external":false,"title":"Update Action Show Message","body":"","category":"5517d087b625a50d001260aa","slug":"update-action-show-message","link_url":"","order":4,"sync_unique":"","__v":0,"createdAt":"2015-07-27T14:19:34.581Z","hidden":false,"childrenPages":[]}

putUpdate Action Show Message

Updates an action of type show message

Path Params

id:
required
integer
Action ID

Body Params

campaign:
required
integer
Campaign ID
title:
required
string
body:
required
string
order:
integer
Position in the stack of actions

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b63e4ec2e909190073ec04","__v":0,"api":{"auth":"required","method":"delete","params":[{"_id":"55b63de4f8105a2f00c34e3d","required":true,"desc":"Action ID","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-show-message/:id"},"body":"","category":"5517d087b625a50d001260aa","createdAt":"2015-07-27T14:21:02.595Z","title":"Delete Action Show Message","excerpt":"Deletes an action of type show message","githubsync":"","link_external":false,"link_url":"","slug":"delete-action-show-message","version":"54c8b329b3334c0d00236654","order":5,"project":"545386120c09721000a069f5","type":"delete","user":"545383ac08d1800800473d8d","editedParams":true,"editedParams2":true,"hidden":false,"sync_unique":"","updates":[],"childrenPages":[]}

deleteDelete Action Show Message

Deletes an action of type show message

Path Params

id:
required
integer
Action ID

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"552578e83620312b008daee1","__v":0,"body":"action_type can be either \"static_page\" or \"ean_code\"","githubsync":"","link_url":"","sync_unique":"","category":"5517d08ef732e32100056ef0","createdAt":"2015-04-08T18:52:24.284Z","excerpt":"Get all actions of type show product info","link_external":false,"hidden":false,"project":"545386120c09721000a069f5","slug":"actions-show-product-get-all","updates":[],"user":"545383ac08d1800800473d8d","api":{"url":"/v:version/actions-show-product","auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"action_type\": \"static_page\",\n    \"campaign\": 1,\n    \"ean_code\": null,\n    \"id\": 1,\n    \"order\": 0,\n    \"static_page\": 1,\n    \"type\": \"ActionShowProduct\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-show-product/1\",\n    \"webview\": \"https://api.movintracks.io/v2.0/webviews/static_pages/1\"\n  }\n]","name":""},{"name":"","status":400,"language":"json","code":"{}"}]}},"order":0,"title":"Get All Actions Show Product","type":"get","version":"54c8b329b3334c0d00236654","childrenPages":[]}

getGet All Actions Show Product

Get all actions of type show product info

action_type can be either "static_page" or "ean_code"

Definition

{{ api_url }}{{ page_api_url }}

Result Format



action_type can be either "static_page" or "ean_code"
{"_id":"55b643ab6127b12500364350","githubsync":"","project":"545386120c09721000a069f5","title":"Get One Action Show Product","version":"54c8b329b3334c0d00236654","user":"545383ac08d1800800473d8d","api":{"params":[{"type":"int","name":"id","in":"query","_id":"55b643ab6127b12500364351","required":true,"desc":"action id","default":""}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"action_type\": \"static_page\",\n  \"campaign\": 1,\n  \"ean_code\": null,\n  \"id\": 1,\n  \"order\": 0,\n  \"static_page\": 1,\n  \"type\": \"ActionShowProduct\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-show-product/1\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/static_pages/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-show-product","auth":"required","method":"get"},"editedParams2":true,"updates":[],"order":1,"type":"get","__v":0,"editedParams":true,"link_external":false,"link_url":"","hidden":false,"slug":"action-show-product-get-one","sync_unique":"","body":"action_type can be either \"static_page\" or \"ean_code\"","category":"5517d08ef732e32100056ef0","createdAt":"2015-07-27T14:43:55.355Z","excerpt":"Get one action of type show product info","childrenPages":[]}

getGet One Action Show Product

Get one action of type show product info

Query Params

id:
required
integer
action id
action_type can be either "static_page" or "ean_code"

Definition

{{ api_url }}{{ page_api_url }}

Result Format



action_type can be either "static_page" or "ean_code"
{"_id":"5559b838c9cbc70d003db21f","link_url":"","title":"Create Actions Show Product","type":"post","user":"545383ac08d1800800473d8d","__v":0,"excerpt":"Create an action of type show product info","hidden":false,"slug":"create-actions-show-product","body":"action_type can be either \"static_page\" or \"ean_code\"","githubsync":"","order":2,"project":"545386120c09721000a069f5","link_external":false,"sync_unique":"","version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"post","params":[{"in":"body","_id":"5559b838c9cbc70d003db224","required":true,"desc":"options: static_page, ean_code","default":"","type":"string","name":"action_type"},{"default":"","type":"int","name":"campaign","in":"body","_id":"5559b838c9cbc70d003db223","required":true,"desc":"campaign id"},{"in":"body","_id":"5559b838c9cbc70d003db222","required":false,"desc":"static page id, required i action_type is static_page","default":"","type":"int","name":"static_page"},{"default":"","type":"int","name":"ean_code","in":"body","_id":"5559b838c9cbc70d003db221","required":false,"desc":"ean code (13 chars), required i action_type is ean_code"},{"required":false,"desc":"order in the stack of actions","default":"0","type":"int","name":"order","in":"body","_id":"5559b838c9cbc70d003db220"}],"results":{"codes":[{"name":"","status":201,"language":"json","code":"{\n  \"action_type\": \"static_page\",\n  \"campaign\": 1,\n  \"ean_code\": null,\n  \"id\": 1,\n  \"order\": 0,\n  \"static_page\": 1,\n  \"type\": \"ActionShowProduct\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-show-product/1\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/static_pages/1\"\n}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/v:version/actions-show-product"},"createdAt":"2015-05-18T10:00:24.928Z","editedParams":true,"editedParams2":true,"category":"5517d08ef732e32100056ef0","updates":[],"childrenPages":[]}

postCreate Actions Show Product

Create an action of type show product info

Body Params

action_type:
required
string
options: static_page, ean_code
campaign:
required
integer
campaign id
static_page:
integer
static page id, required i action_type is static_page
ean_code:
integer
ean code (13 chars), required i action_type is ean_code
order:
integer0
order in the stack of actions
action_type can be either "static_page" or "ean_code"

Definition

{{ api_url }}{{ page_api_url }}

Result Format



action_type can be either "static_page" or "ean_code"
{"_id":"55b644956127b1250036437a","api":{"auth":"required","method":"patch","params":[{"type":"int","name":"id","in":"path","_id":"55b644956127b1250036437b","required":true,"desc":"action ID","default":""},{"_id":"5559b838c9cbc70d003db224","required":true,"desc":"options: static_page, ean_code","default":"","type":"string","name":"action_type","in":"body"},{"in":"body","_id":"5559b838c9cbc70d003db223","required":true,"desc":"campaign id","default":"","type":"int","name":"campaign"},{"type":"int","name":"static_page","in":"body","_id":"5559b838c9cbc70d003db222","required":false,"desc":"static page id, required i action_type is static_page","default":""},{"_id":"5559b838c9cbc70d003db221","required":false,"desc":"ean code (13 chars), required i action_type is ean_code","default":"","type":"int","name":"ean_code","in":"body"},{"_id":"5559b838c9cbc70d003db220","required":false,"desc":"order in the stack of actions","default":"0","type":"int","name":"order","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"action_type\": \"static_page\",\n  \"campaign\": 1,\n  \"ean_code\": null,\n  \"id\": 1,\n  \"order\": 0,\n  \"static_page\": 1,\n  \"type\": \"ActionShowProduct\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-show-product/1\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/static_pages/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-show-product/:id"},"body":"action_type can be either \"static_page\" or \"ean_code\"","createdAt":"2015-07-27T14:47:49.739Z","editedParams":true,"excerpt":"Partially updates an action of type show product info","updates":[],"user":"545383ac08d1800800473d8d","category":"5517d08ef732e32100056ef0","editedParams2":true,"githubsync":"","project":"545386120c09721000a069f5","sync_unique":"","title":"Partial Update Actions Show Product","type":"patch","link_url":"","order":3,"slug":"actions-show-product-partial-update","version":"54c8b329b3334c0d00236654","__v":0,"hidden":false,"link_external":false,"childrenPages":[]}

patchPartial Update Actions Show Product

Partially updates an action of type show product info

Path Params

id:
required
integer
action ID

Body Params

action_type:
required
string
options: static_page, ean_code
campaign:
required
integer
campaign id
static_page:
integer
static page id, required i action_type is static_page
ean_code:
integer
ean code (13 chars), required i action_type is ean_code
order:
integer0
order in the stack of actions
action_type can be either "static_page" or "ean_code"

Definition

{{ api_url }}{{ page_api_url }}

Result Format



action_type can be either "static_page" or "ean_code"
{"_id":"55b644d2c2e909190073ec21","__v":0,"api":{"auth":"required","method":"put","params":[{"_id":"55b644956127b1250036437b","required":true,"desc":"action ID","default":"","type":"int","name":"id","in":"path"},{"in":"body","_id":"5559b838c9cbc70d003db224","required":true,"desc":"options: static_page, ean_code","default":"","type":"string","name":"action_type"},{"default":"","type":"int","name":"campaign","in":"body","_id":"5559b838c9cbc70d003db223","required":true,"desc":"campaign id"},{"required":false,"desc":"static page id, required i action_type is static_page","default":"","type":"int","name":"static_page","in":"body","_id":"5559b838c9cbc70d003db222"},{"desc":"ean code (13 chars), required i action_type is ean_code","default":"","type":"int","name":"ean_code","in":"body","_id":"5559b838c9cbc70d003db221","required":false},{"type":"int","name":"order","in":"body","_id":"5559b838c9cbc70d003db220","required":false,"desc":"order in the stack of actions","default":"0"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"action_type\": \"static_page\",\n  \"campaign\": 1,\n  \"ean_code\": null,\n  \"id\": 1,\n  \"order\": 0,\n  \"static_page\": 1,\n  \"type\": \"ActionShowProduct\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-show-product/1\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/static_pages/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-show-product/:id"},"category":"5517d08ef732e32100056ef0","editedParams":true,"githubsync":"","order":4,"project":"545386120c09721000a069f5","version":"54c8b329b3334c0d00236654","hidden":false,"slug":"update-actions-show-product","type":"put","title":"Update Actions Show Product","body":"action_type can be either \"static_page\" or \"ean_code\"","createdAt":"2015-07-27T14:48:50.947Z","editedParams2":true,"excerpt":"Updates an action of type show product info","link_external":false,"link_url":"","sync_unique":"","updates":[],"user":"545383ac08d1800800473d8d","childrenPages":[]}

putUpdate Actions Show Product

Updates an action of type show product info

Path Params

id:
required
integer
action ID

Body Params

action_type:
required
string
options: static_page, ean_code
campaign:
required
integer
campaign id
static_page:
integer
static page id, required i action_type is static_page
ean_code:
integer
ean code (13 chars), required i action_type is ean_code
order:
integer0
order in the stack of actions
action_type can be either "static_page" or "ean_code"

Definition

{{ api_url }}{{ page_api_url }}

Result Format



action_type can be either "static_page" or "ean_code"
{"_id":"55b6454cc2e909190073ec23","link_url":"","project":"545386120c09721000a069f5","sync_unique":"","body":"action_type can be either \"static_page\" or \"ean_code\"","category":"5517d08ef732e32100056ef0","githubsync":"","__v":0,"editedParams":true,"version":"54c8b329b3334c0d00236654","order":5,"title":"Delete Actions Show Product","updates":[],"user":"545383ac08d1800800473d8d","editedParams2":true,"excerpt":"Deletes an action of type show product info","hidden":false,"link_external":false,"api":{"url":"/v:version/actions-show-product/:id","auth":"required","method":"delete","params":[{"desc":"action ID","default":"","type":"int","name":"id","in":"path","_id":"55b644956127b1250036437b","required":true}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"createdAt":"2015-07-27T14:50:52.175Z","slug":"delete-actions-show-product","type":"delete","childrenPages":[]}

deleteDelete Actions Show Product

Deletes an action of type show product info

Path Params

id:
required
integer
action ID
action_type can be either "static_page" or "ean_code"

Definition

{{ api_url }}{{ page_api_url }}


action_type can be either "static_page" or "ean_code"
{"_id":"55257aee58aa012100cefbdf","sync_unique":"","updates":[],"version":"54c8b329b3334c0d00236654","excerpt":"","api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"action_type\": \"follow\",\n    \"campaign\": 1,\n    \"id\": 1,\n    \"img_url\": \"\",\n    \"message\": null,\n    \"message_link\": null,\n    \"order\": null,\n    \"social_profile\": 1,\n    \"static_page\": null,\n    \"target_social_network\": null,\n    \"type\": \"ActionSocial\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-social/1\",\n    \"url_action\": null,\n    \"webview\": \"\"\n  }\n]","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/actions-social","auth":"required","method":"get","params":[]},"body":"There are two types of social actions:\n* User posts to social network (action_type: post_message, post_image)\n* User is invited to interact with your social networks (action_type: follow, visit)\n\nDepending on the type, some fields are required when creating objects of type ActionSocial.","githubsync":"","order":0,"title":"Get All Actions Social","user":"545383ac08d1800800473d8d","link_url":"","project":"545386120c09721000a069f5","type":"get","__v":1,"createdAt":"2015-04-08T19:01:02.894Z","hidden":false,"link_external":false,"slug":"actions-social-get-all","category":"5517d09782f73b0d004026a3","childrenPages":[]}

getGet All Actions Social


There are two types of social actions: * User posts to social network (action_type: post_message, post_image) * User is invited to interact with your social networks (action_type: follow, visit) Depending on the type, some fields are required when creating objects of type ActionSocial.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



There are two types of social actions: * User posts to social network (action_type: post_message, post_image) * User is invited to interact with your social networks (action_type: follow, visit) Depending on the type, some fields are required when creating objects of type ActionSocial.
{"_id":"555f55de57fe0a0d00c8f4b6","githubsync":"","updates":[],"version":"54c8b329b3334c0d00236654","__v":1,"editedParams":true,"link_url":"","order":1,"user":"545383ac08d1800800473d8d","createdAt":"2015-05-22T16:14:22.374Z","excerpt":"Creates actions of type social","link_external":false,"slug":"actions-social-create","type":"post","editedParams2":true,"hidden":false,"project":"545386120c09721000a069f5","sync_unique":"","title":"Create Actions Social","api":{"auth":"required","method":"post","params":[{"_id":"555f55de57fe0a0d00c8f4ba","required":true,"desc":"options: follow, visit, post_image, post_message","default":"","type":"string","name":"action_type","in":"body"},{"in":"body","_id":"555f55de57fe0a0d00c8f4b9","required":true,"desc":"campaign id","default":"","type":"int","name":"campaign"},{"type":"string","name":"message","in":"body","_id":"555f55de57fe0a0d00c8f4b8","required":false,"desc":"message to be published in a social network (when action_type is post_message)","default":""},{"_id":"555f55de57fe0a0d00c8f4b7","required":false,"desc":"URL to be published in a social network (when action_type is post_image or post_message)","default":"","type":"string","name":"message_link","in":"body"},{"required":false,"desc":"Social Profile Id (when action_type is follow or visit)","default":"","type":"int","name":"social_profile","in":"body","_id":"555f5665750e240d00cc31c2"},{"desc":"Options: facebook, twitter. A case sensitive name of the social network where the message will be published (when action_type is post_image or post_message)","default":"","type":"string","name":"target_social_network","in":"body","_id":"555f5665750e240d00cc31c1","required":false},{"type":"string","name":"url_action","in":"body","_id":"555f5665750e240d00cc31c0","required":false,"desc":"URL to be published in a social network (when action_type is post_image or post_message)","default":""}],"results":{"codes":[{"name":"","code":"{\n  \"action_type\": \"follow\",\n  \"campaign\": 1,\n  \"id\": 1,\n  \"img_url\": \"\",\n  \"message\": null,\n  \"message_link\": null,\n  \"order\": null,\n  \"social_profile\": 1,\n  \"static_page\": null,\n  \"target_social_network\": null,\n  \"type\": \"ActionSocial\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-social/1\",\n  \"url_action\": null,\n  \"webview\": \"\"\n}","language":"json","status":201},{"code":"{}","language":"json","status":400,"name":""}]},"url":"/v:version/actions-social"},"body":"There are two types of social actions:\n* User posts to social network (action_type: post_message, post_image)\n* User is invited to interact with your social networks (action_type: follow, visit)\n\nDepending on the type, some fields are **required** when creating objects of type ActionSocial.","category":"5517d09782f73b0d004026a3","childrenPages":[]}

postCreate Actions Social

Creates actions of type social

Body Params

action_type:
required
string
options: follow, visit, post_image, post_message
campaign:
required
integer
campaign id
message:
string
message to be published in a social network (when action_type is post_message)
message_link:
string
URL to be published in a social network (when action_type is post_image or post_message)
social_profile:
integer
Social Profile Id (when action_type is follow or visit)
target_social_network:
string
Options: facebook, twitter. A case sensitive name of the social network where the message will be published (when action_type is post_image or post_message)
url_action:
string
URL to be published in a social network (when action_type is post_image or post_message)
There are two types of social actions: * User posts to social network (action_type: post_message, post_image) * User is invited to interact with your social networks (action_type: follow, visit) Depending on the type, some fields are **required** when creating objects of type ActionSocial.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



There are two types of social actions: * User posts to social network (action_type: post_message, post_image) * User is invited to interact with your social networks (action_type: follow, visit) Depending on the type, some fields are **required** when creating objects of type ActionSocial.
{"_id":"55257b87a996d03100cc76d4","createdAt":"2015-04-08T19:03:35.744Z","body":"","category":"5517d09f15f7bd170082e4b8","order":0,"project":"545386120c09721000a069f5","type":"get","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 1,\n    \"order\": 0,\n    \"survey\": 1,\n    \"type\": \"ActionSurvey\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-survey/1\",\n    \"webview\": \"https://api.movintracks.io/v2.0/webviews/surveys/1\"\n  }\n]\n","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-survey"},"githubsync":"","link_external":false,"title":"Get All Actions Survey","updates":[],"version":"54c8b329b3334c0d00236654","__v":0,"excerpt":"","hidden":false,"link_url":"","slug":"actions-survey-get-all","sync_unique":"","childrenPages":[]}

getGet All Actions Survey


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b64ea86127b125003643c0","project":"545386120c09721000a069f5","title":"Get One Action Survey","type":"get","createdAt":"2015-07-27T15:30:48.332Z","link_external":false,"link_url":"","order":1,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"__v":0,"api":{"method":"get","params":[{"desc":"action id","default":"","type":"int","name":"id","in":"path","_id":"55b64ea86127b125003643c1","required":true}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"survey\": 1,\n  \"type\": \"ActionSurvey\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-survey/1\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/surveys/1\"\n}\n","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-survey/:id","auth":"required"},"body":"","editedParams":true,"slug":"get-one-action-survey","user":"545383ac08d1800800473d8d","category":"5517d09f15f7bd170082e4b8","updates":[],"version":"54c8b329b3334c0d00236654","sync_unique":"","childrenPages":[]}

getGet One Action Survey


Path Params

id:
required
integer
action id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f59b1750e240d00cc31d1","createdAt":"2015-05-22T16:30:41.054Z","editedParams":true,"githubsync":"","hidden":false,"order":2,"slug":"actions-survey-create","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","body":"","category":"5517d09f15f7bd170082e4b8","editedParams2":true,"link_external":false,"link_url":"","api":{"auth":"required","method":"post","params":[{"_id":"555f59b1750e240d00cc31d4","required":true,"desc":"campaign id","default":"","type":"int","name":"campaign","in":"body"},{"required":true,"desc":"position in the stack of actions","default":"","type":"int","name":"order","in":"body","_id":"555f59b1750e240d00cc31d3"},{"name":"survey","in":"body","_id":"555f59b1750e240d00cc31d2","required":true,"desc":"survey id","default":"","type":"int"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"survey\": 1,\n  \"type\": \"ActionSurvey\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-survey/1\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/surveys/1\"\n}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/actions-survey"},"sync_unique":"","title":"Create Actions Survey","project":"545386120c09721000a069f5","excerpt":"Creates actions of type survey","type":"post","updates":[],"__v":0,"childrenPages":[]}

postCreate Actions Survey

Creates actions of type survey

Body Params

campaign:
required
integer
campaign id
order:
required
integer
position in the stack of actions
survey:
required
integer
survey id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b64dfc6127b125003643bb","excerpt":"","hidden":false,"body":"","category":"5517d09f15f7bd170082e4b8","editedParams":true,"type":"patch","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","editedParams2":true,"order":3,"sync_unique":"","link_external":false,"link_url":"","slug":"partial-update-actions-survey","title":"Partial Update Actions Survey","updates":[],"__v":0,"createdAt":"2015-07-27T15:27:56.862Z","githubsync":"","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"survey\": 1,\n  \"type\": \"ActionSurvey\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-survey/1\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/surveys/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-survey/:id","auth":"required","method":"patch","params":[{"required":true,"desc":"action id","default":"","type":"int","name":"id","in":"path","_id":"55b64dfc6127b125003643bc"},{"name":"campaign","in":"body","_id":"555f59b1750e240d00cc31d4","required":false,"desc":"campaign id","default":"","type":"int"},{"desc":"position in the stack of actions","default":"","type":"int","name":"order","in":"body","_id":"555f59b1750e240d00cc31d3","required":false},{"default":"","type":"int","name":"survey","in":"body","_id":"555f59b1750e240d00cc31d2","required":false,"desc":"survey id"}]},"project":"545386120c09721000a069f5","childrenPages":[]}

patchPartial Update Actions Survey


Path Params

id:
required
integer
action id

Body Params

campaign:
integer
campaign id
order:
integer
position in the stack of actions
survey:
integer
survey id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b64e1f6127b125003643be","hidden":false,"link_url":"","version":"54c8b329b3334c0d00236654","updates":[],"user":"545383ac08d1800800473d8d","__v":0,"api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"survey\": 1,\n  \"type\": \"ActionSurvey\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-survey/1\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/surveys/1\"\n}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-survey/:id","auth":"required","method":"put","params":[{"type":"int","name":"id","in":"path","_id":"55b64dfc6127b125003643bc","required":true,"desc":"action id","default":""},{"_id":"555f59b1750e240d00cc31d4","required":true,"desc":"campaign id","default":"","type":"int","name":"campaign","in":"body"},{"required":false,"desc":"position in the stack of actions","default":"","type":"int","name":"order","in":"body","_id":"555f59b1750e240d00cc31d3"},{"desc":"survey id","default":"","type":"int","name":"survey","in":"body","_id":"555f59b1750e240d00cc31d2","required":true}]},"category":"5517d09f15f7bd170082e4b8","order":4,"project":"545386120c09721000a069f5","editedParams":true,"excerpt":"","slug":"update-actions-survey","link_external":false,"sync_unique":"","title":"Update Actions Survey","body":"","createdAt":"2015-07-27T15:28:31.727Z","editedParams2":true,"githubsync":"","type":"put","childrenPages":[]}

putUpdate Actions Survey


Path Params

id:
required
integer
action id

Body Params

campaign:
required
integer
campaign id
order:
integer
position in the stack of actions
survey:
required
integer
survey id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b64e6bc2e909190073ec74","editedParams2":true,"excerpt":"","user":"545383ac08d1800800473d8d","category":"5517d09f15f7bd170082e4b8","body":"","editedParams":true,"githubsync":"","order":5,"sync_unique":"","title":"Delete Actions Survey","updates":[],"hidden":false,"link_external":false,"slug":"delete-actions-survey","__v":0,"createdAt":"2015-07-27T15:29:47.279Z","link_url":"","project":"545386120c09721000a069f5","type":"delete","version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"delete","params":[{"_id":"55b64dfc6127b125003643bc","required":true,"desc":"action id","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-survey/:id"},"childrenPages":[]}

deleteDelete Actions Survey


Path Params

id:
required
integer
action id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"55257be9f162440d005df1aa","updates":[],"version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 1,\n    \"order\": 0,\n    \"type\": \"ActionVibrate\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-vibrate/1\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-vibrate"},"createdAt":"2015-04-08T19:05:13.413Z","githubsync":"","hidden":false,"link_external":false,"sync_unique":"","user":"545383ac08d1800800473d8d","__v":0,"body":"","category":"5517d0a515f7bd170082e4b9","excerpt":"","link_url":"","slug":"actions-vibrate-get-all","order":0,"project":"545386120c09721000a069f5","title":"Get All Actions Vibrate","type":"get","childrenPages":[]}

getGet All Actions Vibrate


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f607857fe0a0d00c8f4db","githubsync":"","slug":"create-actions-vibrate","title":"Create Actions Vibrate","api":{"auth":"required","method":"post","params":[{"type":"int","name":"campaign","in":"body","_id":"555f607857fe0a0d00c8f4dd","required":true,"desc":"campaign id","default":""},{"_id":"555f607857fe0a0d00c8f4dc","required":false,"desc":"position in the stack of actions","default":"","type":"int","name":"order","in":"body"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionVibrate\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-vibrate/1\"\n}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/actions-vibrate"},"category":"5517d0a515f7bd170082e4b9","excerpt":"","__v":0,"editedParams":true,"link_url":"","link_external":false,"order":1,"project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","body":"","createdAt":"2015-05-22T16:59:36.956Z","hidden":false,"type":"post","updates":[],"editedParams2":true,"sync_unique":"","childrenPages":[]}

postCreate Actions Vibrate


Body Params

campaign:
required
integer
campaign id
order:
integer
position in the stack of actions

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55257c443620312b008daee7","createdAt":"2015-04-08T19:06:44.251Z","link_url":"","sync_unique":"","updates":[],"user":"545383ac08d1800800473d8d","type":"get","version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 1,\n    \"order\": 0,\n    \"type\": \"ActionVisitURL\",\n    \"url\": \"https://api.movintracks.io/v2.0/actions-visit-url/1\",\n    \"url_action\": \"http://www.example.org\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-visit-url"},"hidden":false,"order":0,"slug":"actions-visit-url-get-all","title":"Get All Actions Visit URL","body":"","link_external":false,"project":"545386120c09721000a069f5","__v":0,"category":"5517d0a8f732e32100056ef1","excerpt":"","githubsync":"","childrenPages":[]}

getGet All Actions Visit URL


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b64c196127b125003643af","__v":0,"category":"5517d0a8f732e32100056ef1","body":"","createdAt":"2015-07-27T15:19:53.346Z","editedParams":true,"hidden":false,"title":"Get One Action Visit URL","type":"get","updates":[],"editedParams2":true,"excerpt":"","githubsync":"","link_external":false,"link_url":"","slug":"get-one-action-visit-url","sync_unique":"","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"get","params":[{"type":"int","name":"id","in":"path","_id":"55b64c196127b125003643b0","required":true,"desc":"action id","default":""}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionVisitURL\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-visit-url/1\",\n  \"url_action\": \"http://www.example.org\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-visit-url/:id"},"order":1,"project":"545386120c09721000a069f5","version":"54c8b329b3334c0d00236654","childrenPages":[]}

getGet One Action Visit URL


Path Params

id:
required
integer
action id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f622457fe0a0d00c8f4de","githubsync":"","order":2,"slug":"actions-visit-url-create","type":"post","updates":[],"version":"54c8b329b3334c0d00236654","category":"5517d0a8f732e32100056ef1","createdAt":"2015-05-22T17:06:44.322Z","editedParams":true,"hidden":false,"sync_unique":"","__v":0,"body":"","editedParams2":true,"title":"Create Actions Visit URL","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"post","params":[{"_id":"555f622457fe0a0d00c8f4e1","required":true,"desc":"campaign id","default":"","type":"int","name":"campaign","in":"body"},{"_id":"555f622457fe0a0d00c8f4e0","required":true,"desc":"URL to open","default":"","type":"string","name":"url_action","in":"body"},{"_id":"555f622457fe0a0d00c8f4df","required":false,"desc":"Position in the stack of actions","default":"","type":"int","name":"order","in":"body"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionVisitURL\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-visit-url/1\",\n  \"url_action\": \"http://www.example.org\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/actions-visit-url"},"excerpt":"","link_external":false,"link_url":"","project":"545386120c09721000a069f5","childrenPages":[]}

postCreate Actions Visit URL


Body Params

campaign:
required
integer
campaign id
url_action:
required
string
URL to open
order:
integer
Position in the stack of actions

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b64cb1c2e909190073ec68","api":{"auth":"required","method":"patch","params":[{"required":true,"type":"int","in":"path","_id":"55b64cb1c2e909190073ec69","default":"","desc":"action id","name":"id"},{"_id":"555f622457fe0a0d00c8f4e1","required":false,"desc":"campaign id","default":"","type":"int","name":"campaign","in":"body"},{"required":false,"desc":"URL to open","default":"","type":"string","name":"url_action","in":"body","_id":"555f622457fe0a0d00c8f4e0"},{"name":"order","in":"body","_id":"555f622457fe0a0d00c8f4df","required":false,"desc":"Position in the stack of actions","default":"","type":"int"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionVisitURL\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-visit-url/1\",\n  \"url_action\": \"http://www.example.org\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/actions-visit-url/:id"},"editedParams":true,"githubsync":"","link_external":false,"link_url":"","sync_unique":"","__v":0,"body":"","title":"Partially Update Actions Visit URL","type":"patch","updates":[],"category":"5517d0a8f732e32100056ef1","editedParams2":true,"order":3,"project":"545386120c09721000a069f5","slug":"partially-update-actions-visit-url","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","createdAt":"2015-07-27T15:22:25.824Z","excerpt":"","hidden":false,"childrenPages":[]}

patchPartially Update Actions Visit URL


Path Params

id:
required
integer
action id

Body Params

campaign:
integer
campaign id
url_action:
string
URL to open
order:
integer
Position in the stack of actions

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b64ce1c2e909190073ec6b","hidden":false,"slug":"update-actions-visit-url","sync_unique":"","title":"Update Actions Visit URL","__v":0,"category":"5517d0a8f732e32100056ef1","editedParams":true,"editedParams2":true,"excerpt":"","link_external":false,"type":"put","body":"","order":4,"user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","api":{"params":[{"default":"","type":"int","name":"id","in":"path","_id":"55b64cb1c2e909190073ec69","required":true,"desc":"action id"},{"required":true,"desc":"campaign id","default":"","type":"int","name":"campaign","in":"body","_id":"555f622457fe0a0d00c8f4e1"},{"desc":"URL to open","default":"","type":"string","name":"url_action","in":"body","_id":"555f622457fe0a0d00c8f4e0","required":true},{"default":"","type":"int","name":"order","in":"body","_id":"555f622457fe0a0d00c8f4df","required":false,"desc":"Position in the stack of actions"}],"results":{"codes":[{"code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"order\": 0,\n  \"type\": \"ActionVisitURL\",\n  \"url\": \"https://api.movintracks.io/v2.0/actions-visit-url/1\",\n  \"url_action\": \"http://www.example.org\"\n}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"/v:version/actions-visit-url/:id","auth":"required","method":"put"},"createdAt":"2015-07-27T15:23:13.860Z","githubsync":"","link_url":"","project":"545386120c09721000a069f5","updates":[],"childrenPages":[]}

putUpdate Actions Visit URL


Path Params

id:
required
integer
action id

Body Params

campaign:
required
integer
campaign id
url_action:
required
string
URL to open
order:
integer
Position in the stack of actions

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b64d3df8105a2f00c34ea1","githubsync":"","link_url":"","sync_unique":"","title":"Delete Actions Visit URL","updates":[],"__v":0,"api":{"url":"/v:version/actions-visit-url/:id","auth":"required","method":"delete","params":[{"name":"id","in":"path","_id":"55b64cb1c2e909190073ec69","required":true,"desc":"action id","default":"","type":"int"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"category":"5517d0a8f732e32100056ef1","createdAt":"2015-07-27T15:24:45.117Z","editedParams2":true,"project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","body":"","hidden":false,"link_external":false,"order":5,"slug":"delete-actions-visit-url","type":"delete","editedParams":true,"excerpt":"","childrenPages":[]}

deleteDelete Actions Visit URL


Path Params

id:
required
integer
action id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"551ea11c610f400d00837de3","link_external":false,"link_url":"","project":"545386120c09721000a069f5","sync_unique":"","__v":3,"createdAt":"2015-04-03T14:18:04.764Z","githubsync":"","order":0,"type":"get","user":"545383ac08d1800800473d8d","body":"","excerpt":"Gets all apps","version":"54c8b329b3334c0d00236654","title":"Get All Apps","hidden":false,"slug":"apps-get-all","updates":[],"api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"language":"json","code":"[\n    {\n        \"api_key\": \"8d...b3b\",\n        \"api_secret\": \"08...047\",\n        \"apn_cert\": \"...\",\n        \"apn_key\": \"...\",\n        \"app_id\": \"io.movintracks.demos.docs\",\n        \"gcm_api_key\": \"...\",\n        \"id\": 1,\n        \"name\": \"Movintracks Barcelona Demo App\",\n        \"url\": \"https://api.movintracks.io/v2.0/apps/1/\",\n        \"url_android\": \"..\",\n        \"url_ios\": \"..\",\n        \"uuid\": \"00000000-0000-0000-0000-000000000000\"\n    }\n]","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/apps"},"category":"5517d0aeb625a50d001260ab","childrenPages":[]}

getGet All Apps

Gets all apps

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551ea29b610f400d00837de5","hidden":false,"link_external":false,"order":1,"__v":1,"createdAt":"2015-04-03T14:24:27.703Z","excerpt":"Gets one apps","githubsync":"","sync_unique":"","type":"get","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"api_key\": \"8d...b3b\",\n  \"api_secret\": \"08...047\",\n  \"apn_cert\": \"...\",\n  \"apn_key\": \"...\",\n  \"app_id\": \"io.movintracks.demos.docs\",\n  \"gcm_api_key\": \"...\",\n  \"id\": 1,\n  \"name\": \"Movintracks Barcelona Demo App\",\n  \"url\": \"https://api.movintracks.io/v2.0/apps/1/\",\n  \"url_android\": \"..\",\n  \"url_ios\": \"..\",\n  \"uuid\": \"00000000-0000-0000-0000-000000000000\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/apps/:id"},"category":"5517d0aeb625a50d001260ab","link_url":"","project":"545386120c09721000a069f5","slug":"apps-get-one","title":"Get One App","updates":[],"body":"","childrenPages":[]}

getGet One App

Gets one apps

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551ea3558503071700b3b741","createdAt":"2015-04-03T14:27:33.404Z","link_external":false,"link_url":"","order":2,"slug":"apps-create","sync_unique":"","title":"Create App","type":"post","api":{"params":[{"type":"string","name":"api_key","in":"body","_id":"551ea4e896e4991900a2d027","required":false,"desc":"Read only","default":""},{"_id":"551ea4e896e4991900a2d026","required":false,"desc":"Read only","default":"","type":"string","name":"api_secret","in":"body"},{"_id":"551ea4e896e4991900a2d025","required":false,"desc":"Apple Push Notification service certificate in PEM format, including  \"----BEGIN ...\" and \"---- END...\", and explicit \\n at the end of all lines.","default":"","type":"string","name":"apn_cert","in":"body"},{"_id":"551ea4e896e4991900a2d024","required":false,"desc":"Apple Push Notification service key in PEM format, including  \"----BEGIN ...\" and \"---- END...\", and explicit \\n at the end of all lines.","default":"","type":"string","name":"apn_key","in":"body"},{"_id":"551ea4e896e4991900a2d023","required":false,"desc":"Google Cloud Message API Key","default":"","type":"string","name":"gcm_api_key","in":"body"},{"_id":"551ea4e896e4991900a2d022","required":false,"desc":"a human-readable name","default":"","type":"string","name":"name","in":"body"},{"required":false,"desc":"URL to download the app for android","default":"","type":"string","name":"url_android","in":"body","_id":"551ea4e896e4991900a2d021"},{"desc":"URL to download the app for iOS","default":"","type":"string","name":"url_ios","in":"body","_id":"551ea4e896e4991900a2d020","required":false},{"default":"","type":"string","name":"uuid","in":"body","_id":"551ea4e896e4991900a2d01f","required":false,"desc":"UUID to filter beacons used with this App"},{"required":false,"desc":"read only link to the detail view of this app","default":"","type":"string","name":"url","in":"body","_id":"551ea501a4f7771700ff7efe"}],"results":{"codes":[{"code":"{\n  \"api_key\": \"8d...b3b\",\n  \"api_secret\": \"08...047\",\n  \"apn_cert\": \"...\",\n  \"apn_key\": \"...\",\n  \"app_id\": \"io.movintracks.demos.docs\",\n  \"gcm_api_key\": \"...\",\n  \"id\": 1,\n  \"name\": \"Movintracks Barcelona Demo App\",\n  \"url\": \"https://api.movintracks.io/v2.0/apps/1/\",\n  \"url_android\": \"..\",\n  \"url_ios\": \"..\",\n  \"uuid\": \"00000000-0000-0000-0000-000000000000\"\n}","name":"","status":201,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"url":"/v:version/apps","auth":"required","method":"post"},"editedParams2":true,"githubsync":"","hidden":false,"updates":[],"version":"54c8b329b3334c0d00236654","__v":3,"category":"5517d0aeb625a50d001260ab","excerpt":"","body":"See the section \"Limits\" to get the latest updates on the allowed number of apps per user. You can only post successfully to this endpoint if the current number of apps is less than the limit.","project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","editedParams":true,"childrenPages":[]}

postCreate App


Body Params

api_key:
string
Read only
api_secret:
string
Read only
apn_cert:
string
Apple Push Notification service certificate in PEM format, including "----BEGIN ..." and "---- END...", and explicit \n at the end of all lines.
apn_key:
string
Apple Push Notification service key in PEM format, including "----BEGIN ..." and "---- END...", and explicit \n at the end of all lines.
gcm_api_key:
string
Google Cloud Message API Key
name:
string
a human-readable name
url_android:
string
URL to download the app for android
url_ios:
string
URL to download the app for iOS
uuid:
string
UUID to filter beacons used with this App
url:
string
read only link to the detail view of this app
See the section "Limits" to get the latest updates on the allowed number of apps per user. You can only post successfully to this endpoint if the current number of apps is less than the limit.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



See the section "Limits" to get the latest updates on the allowed number of apps per user. You can only post successfully to this endpoint if the current number of apps is less than the limit.
{"_id":"551ea5e6a4f7771700ff7eff","category":"5517d0aeb625a50d001260ab","sync_unique":"","type":"patch","updates":[],"user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","__v":0,"excerpt":"Partially update an app","link_url":"","slug":"apps-partial-update","title":"Partial Update App","api":{"auth":"required","method":"patch","params":[{"_id":"551ea4e896e4991900a2d027","required":false,"desc":"Read only","default":"","type":"string","name":"api_key","in":"body"},{"in":"body","_id":"551ea4e896e4991900a2d026","required":false,"desc":"Read only","default":"","type":"string","name":"api_secret"},{"type":"string","name":"apn_cert","in":"body","_id":"551ea4e896e4991900a2d025","required":false,"desc":"Apple Push Notification service certificate in PEM format, including  \"----BEGIN ...\" and \"---- END...\", and explicit \\n at the end of all lines.","default":""},{"_id":"551ea4e896e4991900a2d024","required":false,"desc":"Apple Push Notification service key in PEM format, including  \"----BEGIN ...\" and \"---- END...\", and explicit \\n at the end of all lines.","default":"","type":"string","name":"apn_key","in":"body"},{"in":"body","_id":"551ea4e896e4991900a2d023","required":false,"desc":"Google Cloud Message API Key","default":"","type":"string","name":"gcm_api_key"},{"default":"","type":"string","name":"name","in":"body","_id":"551ea4e896e4991900a2d022","required":false,"desc":"a human-readable name"},{"in":"body","_id":"551ea4e896e4991900a2d021","required":false,"desc":"URL to download the app for android","default":"","type":"string","name":"url_android"},{"type":"string","name":"url_ios","in":"body","_id":"551ea4e896e4991900a2d020","required":false,"desc":"URL to download the app for iOS","default":""},{"_id":"551ea4e896e4991900a2d01f","required":false,"desc":"UUID to filter beacons used with this App","default":"","type":"string","name":"uuid","in":"body"},{"in":"body","_id":"551ea501a4f7771700ff7efe","required":false,"desc":"read only link to the detail view of this app","default":"","type":"string","name":"url"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"api_key\": \"8d...b3b\",\n  \"api_secret\": \"08...047\",\n  \"apn_cert\": \"...\",\n  \"apn_key\": \"...\",\n  \"app_id\": \"io.movintracks.demos.docs\",\n  \"gcm_api_key\": \"...\",\n  \"id\": 1,\n  \"name\": \"Movintracks Barcelona Demo App\",\n  \"url\": \"https://api.movintracks.io/v2.0/apps/1/\",\n  \"url_android\": \"..\",\n  \"url_ios\": \"..\",\n  \"uuid\": \"00000000-0000-0000-0000-000000000000\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/apps/:id"},"createdAt":"2015-04-03T14:38:30.900Z","editedParams2":true,"githubsync":"","hidden":false,"body":"","editedParams":true,"project":"545386120c09721000a069f5","link_external":false,"order":3,"childrenPages":[]}

patchPartial Update App

Partially update an app

Body Params

api_key:
string
Read only
api_secret:
string
Read only
apn_cert:
string
Apple Push Notification service certificate in PEM format, including "----BEGIN ..." and "---- END...", and explicit \n at the end of all lines.
apn_key:
string
Apple Push Notification service key in PEM format, including "----BEGIN ..." and "---- END...", and explicit \n at the end of all lines.
gcm_api_key:
string
Google Cloud Message API Key
name:
string
a human-readable name
url_android:
string
URL to download the app for android
url_ios:
string
URL to download the app for iOS
uuid:
string
UUID to filter beacons used with this App
url:
string
read only link to the detail view of this app

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551ea642a4f7771700ff7f00","project":"545386120c09721000a069f5","sync_unique":"","title":"Update App","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"put","params":[{"_id":"551ea4e896e4991900a2d027","required":false,"desc":"Read only","default":"","type":"string","name":"api_key","in":"body"},{"_id":"551ea4e896e4991900a2d026","required":false,"desc":"Read only","default":"","type":"string","name":"api_secret","in":"body"},{"required":false,"desc":"Apple Push Notification service certificate in PEM format, including  \"----BEGIN ...\" and \"---- END...\", and explicit \\n at the end of all lines.","default":"","type":"string","name":"apn_cert","in":"body","_id":"551ea4e896e4991900a2d025"},{"desc":"Apple Push Notification service key in PEM format, including  \"----BEGIN ...\" and \"---- END...\", and explicit \\n at the end of all lines.","default":"","type":"string","name":"apn_key","in":"body","_id":"551ea4e896e4991900a2d024","required":false},{"type":"string","name":"gcm_api_key","in":"body","_id":"551ea4e896e4991900a2d023","required":false,"desc":"Google Cloud Message API Key","default":""},{"_id":"551ea4e896e4991900a2d022","required":false,"desc":"a human-readable name","default":"","type":"string","name":"name","in":"body"},{"_id":"551ea4e896e4991900a2d021","required":false,"desc":"URL to download the app for android","default":"","type":"string","name":"url_android","in":"body"},{"_id":"551ea4e896e4991900a2d020","required":false,"desc":"URL to download the app for iOS","default":"","type":"string","name":"url_ios","in":"body"},{"in":"body","_id":"551ea4e896e4991900a2d01f","required":false,"desc":"UUID to filter beacons used with this App","default":"","type":"string","name":"uuid"},{"default":"","type":"string","name":"url","in":"body","_id":"551ea501a4f7771700ff7efe","required":false,"desc":"read only link to the detail view of this app"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"api_key\": \"8d...b3b\",\n  \"api_secret\": \"08...047\",\n  \"apn_cert\": \"...\",\n  \"apn_key\": \"...\",\n  \"app_id\": \"io.movintracks.demos.docs\",\n  \"gcm_api_key\": \"...\",\n  \"id\": 1,\n  \"name\": \"Movintracks Barcelona Demo App\",\n  \"url\": \"https://api.movintracks.io/v2.0/apps/1/\",\n  \"url_android\": \"..\",\n  \"url_ios\": \"..\",\n  \"uuid\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"language":"json","code":"{}","name":"","status":400}]},"url":"/v:version/apps/:id"},"body":"","githubsync":"","link_external":false,"link_url":"","slug":"apps-update","createdAt":"2015-04-03T14:40:02.859Z","editedParams2":true,"excerpt":"Update an app","type":"put","updates":[],"version":"54c8b329b3334c0d00236654","__v":0,"category":"5517d0aeb625a50d001260ab","editedParams":true,"hidden":false,"order":4,"childrenPages":[]}

putUpdate App

Update an app

Body Params

api_key:
string
Read only
api_secret:
string
Read only
apn_cert:
string
Apple Push Notification service certificate in PEM format, including "----BEGIN ..." and "---- END...", and explicit \n at the end of all lines.
apn_key:
string
Apple Push Notification service key in PEM format, including "----BEGIN ..." and "---- END...", and explicit \n at the end of all lines.
gcm_api_key:
string
Google Cloud Message API Key
name:
string
a human-readable name
url_android:
string
URL to download the app for android
url_ios:
string
URL to download the app for iOS
uuid:
string
UUID to filter beacons used with this App
url:
string
read only link to the detail view of this app

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551ea6bfa4f7771700ff7f01","link_url":"","order":5,"type":"delete","category":"5517d0aeb625a50d001260ab","githubsync":"","excerpt":"Delete one app","hidden":false,"slug":"apps-delete","sync_unique":"","title":"Delete App","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"delete","params":[],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/:version/apps/:id"},"link_external":false,"createdAt":"2015-04-03T14:42:07.293Z","project":"545386120c09721000a069f5","updates":[],"version":"54c8b329b3334c0d00236654","__v":0,"body":"","childrenPages":[]}

deleteDelete App

Delete one app

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"55257db03620312b008daeea","body":"","githubsync":"","project":"545386120c09721000a069f5","sync_unique":"","type":"get","__v":0,"createdAt":"2015-04-08T19:12:48.298Z","excerpt":"","link_url":"","version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"major\": 25,\n    \"minor\": 25,\n    \"point\": 1,\n    \"url\": \"https://api.movintracks.io/v2.0/beacons/1\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/beacons"},"category":"5517d0b607dedf0d00a3f5aa","slug":"beacons-get-all","updates":[],"hidden":false,"link_external":false,"order":0,"title":"Get All Beacons","user":"545383ac08d1800800473d8d","childrenPages":[]}

getGet All Beacons


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b646e6f8105a2f00c34e6f","body":"","project":"545386120c09721000a069f5","slug":"get-one-beacons","sync_unique":"","editedParams":true,"editedParams2":true,"title":"Get One Beacon","type":"get","version":"54c8b329b3334c0d00236654","__v":0,"category":"5517d0b607dedf0d00a3f5aa","createdAt":"2015-07-27T14:57:42.185Z","hidden":false,"link_url":"","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"get","params":[{"_id":"55b646e6f8105a2f00c34e70","required":true,"desc":"beacon id","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"major\": 25,\n  \"minor\": 25,\n  \"point\": 1,\n  \"url\": \"https://api.movintracks.io/v2.0/beacons/1\"\n}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/v:version/beacons/:id"},"excerpt":"","githubsync":"","link_external":false,"order":1,"updates":[],"childrenPages":[]}

getGet One Beacon


Path Params

id:
required
integer
beacon id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f0117750e240d00cc30fc","api":{"auth":"required","method":"post","params":[{"name":"major","in":"body","_id":"555f0117750e240d00cc30ff","required":true,"desc":"Beacon major in base 10","default":"","type":"int"},{"desc":"Beacon minor in base 10","default":"","type":"int","name":"minor","in":"body","_id":"555f0117750e240d00cc30fe","required":true},{"default":"","type":"int","name":"point","in":"body","_id":"555f0117750e240d00cc30fd","required":true,"desc":"Point id"}],"results":{"codes":[{"name":"","status":201,"language":"json","code":"{\n  \"major\": 25,\n  \"minor\": 25,\n  \"point\": 1,\n  \"url\": \"https://api.movintracks.io/v2.0/beacons/1\"\n}"},{"language":"json","code":"{}","name":"","status":400}]},"url":"/v:version/beacons"},"category":"5517d0b607dedf0d00a3f5aa","editedParams2":true,"excerpt":"","order":2,"link_external":false,"project":"545386120c09721000a069f5","sync_unique":"","user":"545383ac08d1800800473d8d","hidden":false,"link_url":"","type":"post","updates":[],"version":"54c8b329b3334c0d00236654","title":"Create Beacons","__v":0,"body":"","createdAt":"2015-05-22T10:12:39.005Z","editedParams":true,"githubsync":"","slug":"create-beacons","childrenPages":[]}

postCreate Beacons


Body Params

major:
required
integer
Beacon major in base 10
minor:
required
integer
Beacon minor in base 10
point:
required
integer
Point id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b645ecc2e909190073ec24","__v":0,"body":"","category":"5517d0b607dedf0d00a3f5aa","createdAt":"2015-07-27T14:53:32.144Z","sync_unique":"","api":{"settings":"","url":"/v:version/beacons","auth":"required","method":"patch","params":[{"_id":"55b645ecc2e909190073ec25","required":true,"desc":"Beacon ID","default":"","type":"int","name":"id","in":"body"},{"in":"body","_id":"555f0117750e240d00cc30ff","required":false,"desc":"Beacon major in base 10","default":"","type":"int","name":"major"},{"type":"int","name":"minor","in":"body","_id":"555f0117750e240d00cc30fe","required":false,"desc":"Beacon minor in base 10","default":""},{"_id":"555f0117750e240d00cc30fd","required":false,"desc":"Point id","default":"","type":"int","name":"point","in":"body"}],"results":{"codes":[{"language":"json","code":"{\n  \"major\": 25,\n  \"minor\": 25,\n  \"point\": 1,\n  \"url\": \"https://api.movintracks.io/v2.0/beacons/1\"\n}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]}},"excerpt":"","githubsync":"","updates":[],"user":"545383ac08d1800800473d8d","editedParams":true,"link_url":"","project":"545386120c09721000a069f5","slug":"partially-update-beacons","title":"Partially Update Beacons","editedParams2":true,"hidden":false,"link_external":false,"order":3,"type":"patch","version":"54c8b329b3334c0d00236654","childrenPages":[]}

patchPartially Update Beacons


Body Params

id:
required
integer
Beacon ID
major:
integer
Beacon major in base 10
minor:
integer
Beacon minor in base 10
point:
integer
Point id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b646a2c2e909190073ec2a","sync_unique":"","updates":[],"version":"54c8b329b3334c0d00236654","hidden":false,"editedParams2":true,"link_external":false,"githubsync":"","link_url":"","order":4,"type":"put","user":"545383ac08d1800800473d8d","body":"","excerpt":"","category":"5517d0b607dedf0d00a3f5aa","createdAt":"2015-07-27T14:56:34.617Z","editedParams":true,"project":"545386120c09721000a069f5","slug":"update-beacons","title":"Update Beacons","__v":0,"api":{"auth":"required","method":"put","params":[{"type":"int","name":"id","in":"path","_id":"55b645ecc2e909190073ec25","required":true,"desc":"Beacon ID","default":""},{"_id":"555f0117750e240d00cc30ff","required":true,"desc":"Beacon major in base 10","default":"","type":"int","name":"major","in":"body"},{"required":true,"desc":"Beacon minor in base 10","default":"","type":"int","name":"minor","in":"body","_id":"555f0117750e240d00cc30fe"},{"desc":"Point id","default":"","type":"int","name":"point","in":"body","_id":"555f0117750e240d00cc30fd","required":true}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"major\": 25,\n  \"minor\": 25,\n  \"point\": 1,\n  \"url\": \"https://api.movintracks.io/v2.0/beacons/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/beacons/:id"},"childrenPages":[]}

putUpdate Beacons


Path Params

id:
required
integer
Beacon ID

Body Params

major:
required
integer
Beacon major in base 10
minor:
required
integer
Beacon minor in base 10
point:
required
integer
Point id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b646c0c2e909190073ec2c","api":{"auth":"required","method":"delete","params":[{"in":"path","_id":"55b645ecc2e909190073ec25","required":true,"desc":"Beacon ID","default":"","type":"int","name":"id"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/beacons/:id"},"body":"","editedParams2":true,"excerpt":"","link_external":false,"sync_unique":"","type":"delete","category":"5517d0b607dedf0d00a3f5aa","createdAt":"2015-07-27T14:57:04.683Z","editedParams":true,"hidden":false,"link_url":"","__v":0,"project":"545386120c09721000a069f5","slug":"delete-beacons","title":"Delete Beacons","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","githubsync":"","order":5,"updates":[],"childrenPages":[]}

deleteDelete Beacons


Path Params

id:
required
integer
Beacon ID

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"551ea6f9a4f7771700ff7f03","body":"A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action.","excerpt":"Gets all campaigns","link_external":false,"slug":"campaigns-get-all","sync_unique":"","title":"Get All Campaigns","type":"get","githubsync":"","hidden":false,"project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"app\": 1,\n    \"can_deliver_bg\": true,\n    \"finish\": \"2015-12-31T23:59:59Z\",\n    \"id\": 1,\n    \"interval_in_seconds\": 3600,\n    \"name\": \"Welcome!\",\n    \"nfc_action\": null,\n    \"start\": \"2015-01-01T22:00:00Z\",\n    \"triggers\": [\n        {\n            \"campaign\": 1,\n            \"direction\": \"enter\",\n            \"distance\": \"far\",\n            \"id\": 1,\n            \"points\": [\n                1\n            ],\n            \"type\": \"TriggerOnVisit\",\n            \"url\": \"https://api.movintracks.io/v2.0/triggers-on-visit/1/\"\n        }\n    ],\n    \"actions\": [\n        {\n            \"body\": \"Welcome to an exciting conference about cardboxes\",\n            \"campaign\": 1,\n            \"id\": 1,\n            \"order\": 0,\n            \"title\": \"Cardboxes Conference\",\n            \"type\": \"ActionShowMessage\",\n            \"url\": \"https://api.movintracks.io/v2.0/actions-show-message/1/\"\n        },\n        {\n            \"campaign\": 1,\n            \"id\": 2,\n            \"order\": 1,\n            \"type\": \"ActionVisitURL\",\n            \"url\": \"https://api.movintracks.io/v2.0/actions-visit-url/2/\",\n            \"url_action\": \"http://www.example.org/\"\n        }\n    ]\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/campaigns"},"link_url":"","version":"54c8b329b3334c0d00236654","__v":4,"category":"54d37f3b87ea950d00f1bcd3","createdAt":"2015-04-03T14:43:05.202Z","order":0,"updates":[],"childrenPages":[]}

getGet All Campaigns

Gets all campaigns

A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action.
{"_id":"551fb23b9aa80d0d00e1774e","version":"54c8b329b3334c0d00236654","createdAt":"2015-04-04T09:43:23.609Z","link_external":false,"project":"545386120c09721000a069f5","slug":"campains-get-one","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"get","params":[{"type":"int","in":"path","_id":"5523d614b8cef12f00fb4be3","default":"","desc":"campaign id","name":"id","required":true}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"app\": 1,\n    \"can_deliver_bg\": true,\n    \"finish\": \"2015-12-31T23:59:59Z\",\n    \"id\": 1,\n    \"interval_in_seconds\": 3600,\n    \"name\": \"Welcome!\",\n    \"nfc_action\": null,\n    \"start\": \"2015-01-01T22:00:00Z\",\n    \"triggers\": [\n        {\n            \"campaign\": 1,\n            \"direction\": \"enter\",\n            \"distance\": \"far\",\n            \"id\": 1,\n            \"points\": [\n                1\n            ],\n            \"type\": \"TriggerOnVisit\",\n            \"url\": \"https://api.movintracks.io/v2.0/triggers-on-visit/1/\"\n        }\n    ],\n    \"actions\": [\n        {\n            \"body\": \"Welcome to an exciting conference about cardboxes\",\n            \"campaign\": 1,\n            \"id\": 1,\n            \"order\": 0,\n            \"title\": \"Cardboxes Conference\",\n            \"type\": \"ActionShowMessage\",\n            \"url\": \"https://api.movintracks.io/v2.0/actions-show-message/1/\"\n        },\n        {\n            \"campaign\": 1,\n            \"id\": 2,\n            \"order\": 1,\n            \"type\": \"ActionVisitURL\",\n            \"url\": \"https://api.movintracks.io/v2.0/actions-visit-url/2/\",\n            \"url_action\": \"http://www.example.org/\"\n        }\n    ]\n}"},{"language":"json","code":"{}","name":"","status":400}]},"url":"/v:version/campaigns/:id"},"editedParams":true,"excerpt":"Gets all campaigns","order":1,"sync_unique":"","type":"get","__v":4,"body":"A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action.","editedParams2":true,"hidden":false,"updates":[],"category":"54d37f3b87ea950d00f1bcd3","githubsync":"","link_url":"","title":"Get One Campaign","childrenPages":[]}

getGet One Campaign

Gets all campaigns

Path Params

id:
required
integer
campaign id
A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action.
{"_id":"551fb5089aa80d0d00e17755","__v":0,"version":"54c8b329b3334c0d00236654","editedParams":true,"hidden":false,"project":"545386120c09721000a069f5","slug":"campaigns-create","sync_unique":"","order":2,"title":"Create Campaign","user":"545383ac08d1800800473d8d","createdAt":"2015-04-04T09:55:20.505Z","excerpt":"Create acampaigns","githubsync":"","link_external":false,"link_url":"","type":"post","updates":[],"api":{"auth":"required","method":"post","params":[{"required":true,"type":"int","in":"body","_id":"551fb5089aa80d0d00e1775c","default":"","desc":"App id","name":"app"},{"_id":"551fb5089aa80d0d00e1775b","required":false,"desc":"Set it to True if the campaign should be delivered in background as well.","default":"","type":"boolean","name":"can_deliver_bg","in":"body"},{"in":"body","_id":"551fb5089aa80d0d00e1775a","default":"","desc":"ISO 8601 datetime: YYYY-MM-DD T HH:MM:SS Z. T and Z are literals.","name":"finish","required":true,"type":"datetime"},{"required":false,"type":"int","in":"body","_id":"551fb5089aa80d0d00e17759","default":"","desc":"Interval between campaign deliveries, in seconds. If not set, the campaign will be launched only once. Min 30s.","name":"interval_in_seconds"},{"_id":"551fb5089aa80d0d00e17758","default":"","desc":"A human-readable name. It can be exposed to users.","name":"name","required":true,"type":"string","in":"body"},{"in":"body","_id":"551fb5089aa80d0d00e17757","required":false,"desc":"Id of the aciton that should be launched when this campaign is linked to an NFC Tag","default":"","type":"string","name":"nfc_action"},{"required":true,"type":"string","in":"body","_id":"551fb5089aa80d0d00e17756","default":"","desc":"ISO 8601 datetime: YYYY-MM-DD T HH:MM:SS Z. T and Z are literals.","name":"start"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n    \"app\": 1,\n    \"can_deliver_bg\": true,\n    \"finish\": \"2015-12-31T23:59:59Z\",\n    \"id\": 2,\n    \"interval_in_seconds\": 1800,\n    \"name\": \"Campaign 2\",\n    \"nfc_action\": null,\n    \"start\": \"2015-01-01T22:00:00Z\",\n    \"triggers\": [],\n    \"actions\": []\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/campaigns"},"body":"A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action.\nTriggers and Actions have to be posted to their corresponding endpoints, not as nested items of campaign.","category":"54d37f3b87ea950d00f1bcd3","editedParams2":true,"childrenPages":[]}

postCreate Campaign

Create acampaigns

Body Params

app:
required
integer
App id
can_deliver_bg:
boolean
Set it to True if the campaign should be delivered in background as well.
finish:
required
datetime
ISO 8601 datetime: YYYY-MM-DD T HH:MM:SS Z. T and Z are literals.
interval_in_seconds:
integer
Interval between campaign deliveries, in seconds. If not set, the campaign will be launched only once. Min 30s.
name:
required
string
A human-readable name. It can be exposed to users.
nfc_action:
string
Id of the aciton that should be launched when this campaign is linked to an NFC Tag
start:
required
string
ISO 8601 datetime: YYYY-MM-DD T HH:MM:SS Z. T and Z are literals.
A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action. Triggers and Actions have to be posted to their corresponding endpoints, not as nested items of campaign.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action. Triggers and Actions have to be posted to their corresponding endpoints, not as nested items of campaign.
{"_id":"551fb6843439220d00f47272","hidden":false,"project":"545386120c09721000a069f5","slug":"campaigns-partial-update","sync_unique":"","title":"Partial Update Campaign","body":"A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action.\nTriggers and Actions have to be posted to their corresponding endpoints, not as nested items of campaign.","category":"54d37f3b87ea950d00f1bcd3","githubsync":"","order":3,"__v":1,"createdAt":"2015-04-04T10:01:40.005Z","editedParams":true,"editedParams2":true,"excerpt":"Partially update a campaign","link_external":false,"link_url":"","updates":[],"version":"54c8b329b3334c0d00236654","user":"545383ac08d1800800473d8d","type":"patch","api":{"auth":"required","method":"patch","params":[{"in":"path","_id":"5523d641c0c1af21004a8f34","required":true,"desc":"campaign id","default":"","type":"int","name":"id"},{"default":"","type":"int","name":"app","in":"body","_id":"551fb5089aa80d0d00e1775c","required":false,"desc":"App id"},{"in":"body","_id":"551fb5089aa80d0d00e1775b","required":false,"desc":"Set it to True if the campaign should be delivered in background as well.","default":"","type":"boolean","name":"can_deliver_bg"},{"default":"","type":"datetime","name":"finish","in":"body","_id":"551fb5089aa80d0d00e1775a","required":false,"desc":"ISO 8601 datetime: YYYY-MM-DD T HH:MM:SS Z. T and Z are literals."},{"required":false,"desc":"Interval between campaign deliveries, in seconds. If not set, the campaign will be launched only once. Min 30s.","default":"","type":"int","name":"interval_in_seconds","in":"body","_id":"551fb5089aa80d0d00e17759"},{"name":"name","in":"body","_id":"551fb5089aa80d0d00e17758","required":false,"desc":"A human-readable name. It can be exposed to users.","default":"","type":"string"},{"name":"nfc_action","in":"body","_id":"551fb5089aa80d0d00e17757","required":false,"desc":"Id of the aciton that should be launched when this campaign is linked to an NFC Tag","default":"","type":"string"},{"desc":"ISO 8601 datetime: YYYY-MM-DD T HH:MM:SS Z. T and Z are literals.","default":"","type":"string","name":"start","in":"body","_id":"551fb5089aa80d0d00e17756","required":false}],"results":{"codes":[{"status":201,"language":"json","code":"{\n    \"app\": 1,\n    \"can_deliver_bg\": true,\n    \"finish\": \"2015-12-31T23:59:59Z\",\n    \"id\": 2,\n    \"interval_in_seconds\": 1800,\n    \"name\": \"Campaign 2\",\n    \"nfc_action\": null,\n    \"start\": \"2015-01-01T22:00:00Z\",\n    \"triggers\": [],\n    \"actions\": []\n}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"url":"/v:version/campaigns/:id"},"childrenPages":[]}

patchPartial Update Campaign

Partially update a campaign

Path Params

id:
required
integer
campaign id

Body Params

app:
integer
App id
can_deliver_bg:
boolean
Set it to True if the campaign should be delivered in background as well.
finish:
datetime
ISO 8601 datetime: YYYY-MM-DD T HH:MM:SS Z. T and Z are literals.
interval_in_seconds:
integer
Interval between campaign deliveries, in seconds. If not set, the campaign will be launched only once. Min 30s.
name:
string
A human-readable name. It can be exposed to users.
nfc_action:
string
Id of the aciton that should be launched when this campaign is linked to an NFC Tag
start:
string
ISO 8601 datetime: YYYY-MM-DD T HH:MM:SS Z. T and Z are literals.
A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action. Triggers and Actions have to be posted to their corresponding endpoints, not as nested items of campaign.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action. Triggers and Actions have to be posted to their corresponding endpoints, not as nested items of campaign.
{"_id":"551fb6f89aa80d0d00e1775d","updates":[],"user":"545383ac08d1800800473d8d","createdAt":"2015-04-04T10:03:36.611Z","editedParams":true,"githubsync":"","hidden":false,"link_url":"","type":"put","version":"54c8b329b3334c0d00236654","api":{"url":"/v:version/campaigns/:id","auth":"required","method":"put","params":[{"_id":"5523d670c0c1af21004a8f35","default":"","desc":"campaign id","name":"id","required":true,"type":"int","in":"path"},{"required":false,"desc":"App id","default":"","type":"int","name":"app","in":"body","_id":"551fb5089aa80d0d00e1775c"},{"desc":"Set it to True if the campaign should be delivered in background as well.","default":"","type":"boolean","name":"can_deliver_bg","in":"body","_id":"551fb5089aa80d0d00e1775b","required":false},{"type":"datetime","name":"finish","in":"body","_id":"551fb5089aa80d0d00e1775a","required":false,"desc":"ISO 8601 datetime: YYYY-MM-DD T HH:MM:SS Z. T and Z are literals.","default":""},{"_id":"551fb5089aa80d0d00e17759","required":false,"desc":"Interval between campaign deliveries, in seconds. If not set, the campaign will be launched only once. Min 30s.","default":"","type":"int","name":"interval_in_seconds","in":"body"},{"required":false,"desc":"A human-readable name. It can be exposed to users.","default":"","type":"string","name":"name","in":"body","_id":"551fb5089aa80d0d00e17758"},{"desc":"Id of the aciton that should be launched when this campaign is linked to an NFC Tag","default":"","type":"string","name":"nfc_action","in":"body","_id":"551fb5089aa80d0d00e17757","required":false},{"default":"","type":"string","name":"start","in":"body","_id":"551fb5089aa80d0d00e17756","required":false,"desc":"ISO 8601 datetime: YYYY-MM-DD T HH:MM:SS Z. T and Z are literals."}],"results":{"codes":[{"name":"","status":201,"language":"json","code":"{\n    \"app\": 1,\n    \"can_deliver_bg\": true,\n    \"finish\": \"2015-12-31T23:59:59Z\",\n    \"id\": 2,\n    \"interval_in_seconds\": 1800,\n    \"name\": \"Campaign 2\",\n    \"nfc_action\": null,\n    \"start\": \"2015-01-01T22:00:00Z\",\n    \"triggers\": [],\n    \"actions\": []\n}"},{"status":400,"language":"json","code":"{}","name":""}]}},"excerpt":"Update a campaign","title":"Update Campaign","category":"54d37f3b87ea950d00f1bcd3","editedParams2":true,"sync_unique":"","__v":1,"body":"A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action.\nTriggers and Actions have to be posted to their corresponding endpoints, not as nested items of campaign.","link_external":false,"order":4,"project":"545386120c09721000a069f5","slug":"update-campaign","childrenPages":[]}

putUpdate Campaign

Update a campaign

Path Params

id:
required
integer
campaign id

Body Params

app:
integer
App id
can_deliver_bg:
boolean
Set it to True if the campaign should be delivered in background as well.
finish:
datetime
ISO 8601 datetime: YYYY-MM-DD T HH:MM:SS Z. T and Z are literals.
interval_in_seconds:
integer
Interval between campaign deliveries, in seconds. If not set, the campaign will be launched only once. Min 30s.
name:
string
A human-readable name. It can be exposed to users.
nfc_action:
string
Id of the aciton that should be launched when this campaign is linked to an NFC Tag
start:
string
ISO 8601 datetime: YYYY-MM-DD T HH:MM:SS Z. T and Z are literals.
A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action. Triggers and Actions have to be posted to their corresponding endpoints, not as nested items of campaign.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



A comprehensive example of a campaign. Notice that triggers and actions are arrays of nested views of Trigger and Action. Triggers and Actions have to be posted to their corresponding endpoints, not as nested items of campaign.
{"_id":"551fb79ff656ee0d0047be12","api":{"params":[{"type":"int","name":"id","in":"path","_id":"5523d697b8cef12f00fb4be7","required":false,"desc":"campaign id","default":""}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/campaigns/:id","auth":"required","method":"delete"},"editedParams2":true,"order":5,"user":"545383ac08d1800800473d8d","body":"Deleting a campaign will delete on cascade objects that depend on it, like actions and triggers.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Deleting can not be undone\",\n  \"body\": \"Deleting an object can not be undone. All objects that depend on it will be deleted as well.\"\n}\n[/block]","sync_unique":"","updates":[],"createdAt":"2015-04-04T10:06:23.313Z","editedParams":true,"hidden":false,"project":"545386120c09721000a069f5","slug":"delete-campaign","version":"54c8b329b3334c0d00236654","__v":2,"category":"54d37f3b87ea950d00f1bcd3","excerpt":"Deletes a campaign","githubsync":"","link_external":false,"link_url":"","title":"Delete Campaign","type":"delete","childrenPages":[]}

deleteDelete Campaign

Deletes a campaign

Path Params

id:
integer
campaign id
Deleting a campaign will delete on cascade objects that depend on it, like actions and triggers. [block:callout] { "type": "danger", "title": "Deleting can not be undone", "body": "Deleting an object can not be undone. All objects that depend on it will be deleted as well." } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Deleting a campaign will delete on cascade objects that depend on it, like actions and triggers. [block:callout] { "type": "danger", "title": "Deleting can not be undone", "body": "Deleting an object can not be undone. All objects that depend on it will be deleted as well." } [/block]
{"_id":"55257d56f162440d005df1ad","__v":1,"api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"color_primary\": \"#000000\",\n    \"color_secondary\": \"#ffffff\",\n    \"description\": \"Lorem ipsum\",\n    \"ean_code\": \"\",\n    \"end\": \"2015-06-12T00:00:00Z\",\n    \"id\": 1,\n    \"img_url\": \"https://movintracks-prod.s3.amazonaws.com/media/b1.png\",\n    \"more_info\": \"Info\",\n    \"name\": \"13 de Febrer Coupon!\",\n    \"offer_description\": \"dasd\",\n    \"offer_value\": \"-14%\",\n    \"organization\": \"Movintracks\",\n    \"passbook\": \"https://api.movintracks.io/v2.0/webviews/coupons-passbook/1\",\n    \"redemption\": \"display_on_screen\",\n    \"terms_and_conditions\": \"Lorem Ipsum\",\n    \"webview\": \"https://api.movintracks.io/v2.0/webviews/coupons/1\"\n  }\n]","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/coupons"},"category":"5517d0c982f73b0d004026a4","link_external":false,"order":0,"updates":[],"body":"","excerpt":"","slug":"coupons-get-all","type":"get","user":"545383ac08d1800800473d8d","createdAt":"2015-04-08T19:11:18.826Z","githubsync":"","hidden":false,"link_url":"","version":"54c8b329b3334c0d00236654","project":"545386120c09721000a069f5","sync_unique":"","title":"Get All Coupons","childrenPages":[]}

getGet All Coupons


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b6515c6127b125003643cf","createdAt":"2015-07-27T15:42:20.302Z","link_url":"","order":1,"title":"Create Coupons","type":"post","updates":[],"user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"post","params":[{"required":false,"desc":"A title","default":"","type":"string","name":"name","in":"body","_id":"55b6515c6127b125003643db"},{"name":"end","in":"body","_id":"55b6515c6127b125003643da","required":true,"desc":"Expiration datetime in ISO8601","default":"","type":"datetime"},{"name":"offer_description","in":"body","_id":"55b6515c6127b125003643d9","required":true,"desc":"","default":"","type":"string"},{"desc":"","default":"","type":"string","name":"offer_value","in":"body","_id":"55b6515c6127b125003643d8","required":true},{"type":"string","name":"redemption","in":"body","_id":"55b6515c6127b125003643d7","required":true,"desc":"Options: display_on_screen, ean_code","default":""},{"_id":"55b6515c6127b125003643d6","required":true,"desc":"","default":"","type":"string","name":"organization","in":"body"},{"in":"body","_id":"55b6515c6127b125003643d5","required":false,"desc":"HTML color. e.g. #000000","default":"","type":"string","name":"color_primary"},{"type":"string","name":"color_secondary","in":"body","_id":"55b6515c6127b125003643d4","required":false,"desc":"HTML color. e.g. #FFFFFF","default":""},{"_id":"55b6515c6127b125003643d3","required":false,"desc":"Bar code","default":"","type":"string","name":"ean_code","in":"body"},{"required":false,"desc":"","default":"","type":"string","name":"more_info","in":"body","_id":"55b6515c6127b125003643d2"},{"desc":"","default":"","type":"string","name":"description","in":"body","_id":"55b6515c6127b125003643d1","required":false},{"type":"string","name":"terms_and_conditions","in":"body","_id":"55b6515c6127b125003643d0","required":false,"desc":"","default":""}],"results":{"codes":[{"language":"json","code":"{\n  \"color_primary\": \"#000000\",\n  \"color_secondary\": \"#ffffff\",\n  \"description\": \"Lorem ipsum\",\n  \"ean_code\": \"\",\n  \"end\": \"2015-06-12T00:00:00Z\",\n  \"id\": 1,\n  \"img_url\": \"https://movintracks-prod.s3.amazonaws.com/media/b1.png\",\n  \"more_info\": \"Info\",\n  \"name\": \"13 de Febrer Coupon!\",\n  \"offer_description\": \"dasd\",\n  \"offer_value\": \"-14%\",\n  \"organization\": \"Movintracks\",\n  \"passbook\": \"https://api.movintracks.io/v2.0/webviews/coupons-passbook/1\",\n  \"redemption\": \"display_on_screen\",\n  \"terms_and_conditions\": \"Lorem Ipsum\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/coupons/1\"\n}","name":"","status":201},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/v:version/coupons"},"slug":"create-coupons","sync_unique":"","__v":0,"editedParams":true,"editedParams2":true,"hidden":false,"link_external":false,"project":"545386120c09721000a069f5","body":"","category":"5517d0c982f73b0d004026a4","excerpt":"","githubsync":"","version":"54c8b329b3334c0d00236654","childrenPages":[]}

postCreate Coupons


Body Params

name:
string
A title
end:
required
datetime
Expiration datetime in ISO8601
offer_description:
required
string
offer_value:
required
string
redemption:
required
string
Options: display_on_screen, ean_code
organization:
required
string
color_primary:
string
HTML color. e.g. #000000
color_secondary:
string
HTML color. e.g. #FFFFFF
ean_code:
string
Bar code
more_info:
string
description:
string
terms_and_conditions:
string

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55257729f162440d005df1a4","title":"Upload Picture for Coupon","user":"545383ac08d1800800473d8d","editedParams":true,"hidden":false,"project":"545386120c09721000a069f5","githubsync":"","link_external":false,"slug":"coupons-upload-picture","sync_unique":"","updates":[],"__v":0,"api":{"settings":"","url":"/v:version/coupons/:id/pic_upload","auth":"required","method":"post","params":[{"_id":"55257454f162440d005df19a","default":"","desc":"coupon id","name":"id","required":true,"type":"int","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"status\": \"Image uploaded successfully.\",\n  \"url\": \"https://movintracks-prod.s3.amazonaws.com/media/123.png\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"excerpt":"Upload a picture for a coupon","editedParams2":true,"link_url":"","order":2,"body":"Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http -f POST https://api.movintracks.io/v2.0/coupons/1/pic_upload \\\"Authorization: Bearer ...\\\" img@lion.png\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","createdAt":"2015-04-08T18:44:57.117Z","category":"5517d0c982f73b0d004026a4","type":"post","version":"54c8b329b3334c0d00236654","childrenPages":[]}

postUpload Picture for Coupon

Upload a picture for a coupon

Path Params

id:
required
integer
coupon id
Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms). [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/v2.0/coupons/1/pic_upload \"Authorization: Bearer ...\" img@lion.png", "language": "shell" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms). [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/v2.0/coupons/1/pic_upload \"Authorization: Bearer ...\" img@lion.png", "language": "shell" } ] } [/block]
{"_id":"55b6520cf8105a2f00c34ebc","excerpt":"","githubsync":"","type":"patch","updates":[],"user":"545383ac08d1800800473d8d","hidden":false,"link_external":false,"order":3,"slug":"partially-update-coupons","editedParams2":true,"project":"545386120c09721000a069f5","sync_unique":"","__v":0,"api":{"url":"/v:version/coupons/:id","auth":"required","method":"patch","params":[{"name":"id","in":"path","_id":"55b6520cf8105a2f00c34ebd","required":true,"desc":"coupon id","default":"","type":"int"},{"desc":"A title","default":"","type":"string","name":"name","in":"body","_id":"55b6515c6127b125003643db","required":false},{"type":"datetime","name":"end","in":"body","_id":"55b6515c6127b125003643da","required":false,"desc":"Expiration datetime in ISO8601","default":""},{"_id":"55b6515c6127b125003643d9","required":false,"desc":"","default":"","type":"string","name":"offer_description","in":"body"},{"required":false,"desc":"","default":"","type":"string","name":"offer_value","in":"body","_id":"55b6515c6127b125003643d8"},{"desc":"Options: display_on_screen, ean_code","default":"","type":"string","name":"redemption","in":"body","_id":"55b6515c6127b125003643d7","required":false},{"type":"string","name":"organization","in":"body","_id":"55b6515c6127b125003643d6","required":false,"desc":"","default":""},{"_id":"55b6515c6127b125003643d5","required":false,"desc":"HTML color. e.g. #000000","default":"","type":"string","name":"color_primary","in":"body"},{"_id":"55b6515c6127b125003643d4","required":false,"desc":"HTML color. e.g. #FFFFFF","default":"","type":"string","name":"color_secondary","in":"body"},{"_id":"55b6515c6127b125003643d3","required":false,"desc":"Bar code","default":"","type":"string","name":"ean_code","in":"body"},{"_id":"55b6515c6127b125003643d2","required":false,"desc":"","default":"","type":"string","name":"more_info","in":"body"},{"required":false,"desc":"","default":"","type":"string","name":"description","in":"body","_id":"55b6515c6127b125003643d1"},{"desc":"","default":"","type":"string","name":"terms_and_conditions","in":"body","_id":"55b6515c6127b125003643d0","required":false}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"color_primary\": \"#000000\",\n  \"color_secondary\": \"#ffffff\",\n  \"description\": \"Lorem ipsum\",\n  \"ean_code\": \"\",\n  \"end\": \"2015-06-12T00:00:00Z\",\n  \"id\": 1,\n  \"img_url\": \"https://movintracks-prod.s3.amazonaws.com/media/b1.png\",\n  \"more_info\": \"Info\",\n  \"name\": \"13 de Febrer Coupon!\",\n  \"offer_description\": \"dasd\",\n  \"offer_value\": \"-14%\",\n  \"organization\": \"Movintracks\",\n  \"passbook\": \"https://api.movintracks.io/v2.0/webviews/coupons-passbook/1\",\n  \"redemption\": \"display_on_screen\",\n  \"terms_and_conditions\": \"Lorem Ipsum\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/coupons/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"body":"","category":"5517d0c982f73b0d004026a4","editedParams":true,"title":"Partially Update Coupons","createdAt":"2015-07-27T15:45:16.133Z","link_url":"","version":"54c8b329b3334c0d00236654","childrenPages":[]}

patchPartially Update Coupons


Path Params

id:
required
integer
coupon id

Body Params

name:
string
A title
end:
datetime
Expiration datetime in ISO8601
offer_description:
string
offer_value:
string
redemption:
string
Options: display_on_screen, ean_code
organization:
string
color_primary:
string
HTML color. e.g. #000000
color_secondary:
string
HTML color. e.g. #FFFFFF
ean_code:
string
Bar code
more_info:
string
description:
string
terms_and_conditions:
string

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b65235c2e909190073ec8a","category":"5517d0c982f73b0d004026a4","hidden":false,"title":"Update Coupons","updates":[],"user":"545383ac08d1800800473d8d","excerpt":"","githubsync":"","link_url":"","sync_unique":"","version":"54c8b329b3334c0d00236654","__v":1,"body":"","editedParams2":true,"order":4,"slug":"update-coupons","type":"put","api":{"auth":"required","method":"put","params":[{"type":"int","name":"id","in":"path","_id":"55b65235c2e909190073ec8b","required":true,"desc":"coupon id","default":""},{"_id":"55b6515c6127b125003643db","required":false,"desc":"A title","default":"","type":"string","name":"name","in":"body"},{"in":"body","_id":"55b6515c6127b125003643da","required":true,"desc":"Expiration datetime in ISO8601","default":"","type":"datetime","name":"end"},{"default":"","type":"string","name":"offer_description","in":"body","_id":"55b6515c6127b125003643d9","required":true,"desc":""},{"in":"body","_id":"55b6515c6127b125003643d8","required":true,"desc":"","default":"","type":"string","name":"offer_value"},{"default":"","type":"string","name":"redemption","in":"body","_id":"55b6515c6127b125003643d7","required":true,"desc":"Options: display_on_screen, ean_code"},{"in":"body","_id":"55b6515c6127b125003643d6","required":true,"desc":"","default":"","type":"string","name":"organization"},{"default":"","type":"string","name":"color_primary","in":"body","_id":"55b6515c6127b125003643d5","required":false,"desc":"HTML color. e.g. #000000"},{"in":"body","_id":"55b6515c6127b125003643d4","required":false,"desc":"HTML color. e.g. #FFFFFF","default":"","type":"string","name":"color_secondary"},{"type":"string","name":"ean_code","in":"body","_id":"55b6515c6127b125003643d3","required":false,"desc":"Bar code","default":""},{"_id":"55b6515c6127b125003643d2","required":false,"desc":"","default":"","type":"string","name":"more_info","in":"body"},{"_id":"55b6515c6127b125003643d1","required":false,"desc":"","default":"","type":"string","name":"description","in":"body"},{"in":"body","_id":"55b6515c6127b125003643d0","required":false,"desc":"","default":"","type":"string","name":"terms_and_conditions"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"color_primary\": \"#000000\",\n  \"color_secondary\": \"#ffffff\",\n  \"description\": \"Lorem ipsum\",\n  \"ean_code\": \"\",\n  \"end\": \"2015-06-12T00:00:00Z\",\n  \"id\": 1,\n  \"img_url\": \"https://movintracks-prod.s3.amazonaws.com/media/b1.png\",\n  \"more_info\": \"Info\",\n  \"name\": \"13 de Febrer Coupon!\",\n  \"offer_description\": \"dasd\",\n  \"offer_value\": \"-14%\",\n  \"organization\": \"Movintracks\",\n  \"passbook\": \"https://api.movintracks.io/v2.0/webviews/coupons-passbook/1\",\n  \"redemption\": \"display_on_screen\",\n  \"terms_and_conditions\": \"Lorem Ipsum\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/coupons/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/coupons/:id"},"createdAt":"2015-07-27T15:45:57.863Z","editedParams":true,"link_external":false,"project":"545386120c09721000a069f5","childrenPages":[]}

putUpdate Coupons


Path Params

id:
required
integer
coupon id

Body Params

name:
string
A title
end:
required
datetime
Expiration datetime in ISO8601
offer_description:
required
string
offer_value:
required
string
redemption:
required
string
Options: display_on_screen, ean_code
organization:
required
string
color_primary:
string
HTML color. e.g. #000000
color_secondary:
string
HTML color. e.g. #FFFFFF
ean_code:
string
Bar code
more_info:
string
description:
string
terms_and_conditions:
string

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b6527dc2e909190073ec8c","__v":0,"api":{"auth":"required","method":"delete","params":[{"required":true,"desc":"coupon id","default":"","type":"int","name":"id","in":"path","_id":"55b65235c2e909190073ec8b"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/v:version/coupons/:id"},"createdAt":"2015-07-27T15:47:09.232Z","project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","githubsync":"","hidden":false,"order":5,"slug":"delete-coupons","title":"Delete Coupons","editedParams2":true,"type":"delete","updates":[],"version":"54c8b329b3334c0d00236654","sync_unique":"","body":"","category":"5517d0c982f73b0d004026a4","editedParams":true,"excerpt":"","link_external":false,"link_url":"","childrenPages":[]}

deleteDelete Coupons


Path Params

id:
required
integer
coupon id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"551fc7673439220d00f47288","api":{"method":"get","params":[],"results":{"codes":[{"name":"","code":"[\n  {\n    \"app\": 1,\n    \"carrier_country\": \"\",\n    \"carrier_name\": \"Carrier\",\n    \"country\": \"CA\",\n    \"customer_id\": \"884d9...bd4ddb59\",\n    \"device_model\": \"iPhone4,1\",\n    \"device_type\": \"iPhone\",\n    \"id\": 1,\n    \"lang\": null,\n    \"location_permissions\": \"True\",\n    \"os\": \"iPhone OS\",\n    \"os_version\": \"7.1.2\",\n    \"push_token\": \"APA...2\",\n    \"sdk_version\": \"1.3\",\n    \"user\": 2\n  },\n  {\n    \"app\": 1,\n    \"carrier_country\": \"\",\n    \"carrier_name\": \"\",\n    \"country\": \"GB\",\n    \"customer_id\": \"d17bac...1c77dddc\",\n    \"device_model\": \"Motorola XT1032\",\n    \"device_type\": \"phone\",\n    \"id\": 2,\n    \"lang\": null,\n    \"location_permissions\": \"True\",\n    \"os\": \"Android\",\n    \"os_version\": \"4.4.4\",\n    \"push_token\": \"APA91b...DBw\",\n    \"sdk_version\": \"1.2.4\",\n    \"user\": 3\n   }\n]","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]},"url":"/v:version/devices","auth":"required"},"excerpt":"Gets all registered devices","order":0,"sync_unique":"","type":"get","__v":4,"project":"545386120c09721000a069f5","slug":"devices-get-all","body":"Regular API users can only list and retrieve devices (read-only). Devices, however, can update (PUT and PATCH) themselves using the SDK.","category":"5517d0d3b625a50d001260ac","createdAt":"2015-04-04T11:13:43.801Z","user":"545383ac08d1800800473d8d","githubsync":"","hidden":false,"link_external":false,"link_url":"","title":"Get All Devices","updates":[],"version":"54c8b329b3334c0d00236654","childrenPages":[]}

getGet All Devices

Gets all registered devices

Regular API users can only list and retrieve devices (read-only). Devices, however, can update (PUT and PATCH) themselves using the SDK.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Regular API users can only list and retrieve devices (read-only). Devices, however, can update (PUT and PATCH) themselves using the SDK.
{"_id":"551fc8593439220d00f4728a","project":"545386120c09721000a069f5","slug":"devices-get-one","type":"get","createdAt":"2015-04-04T11:17:45.537Z","excerpt":"Gets one registered device","hidden":false,"link_url":"","order":1,"version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"get","params":[{"_id":"551fc8593439220d00f4728b","required":false,"desc":"device id","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n    \"app\": 1,\n    \"carrier_country\": \"\",\n    \"carrier_name\": \"Carrier\",\n    \"country\": \"CA\",\n    \"customer_id\": \"884d9...bd4ddb59\",\n    \"device_model\": \"iPhone4,1\",\n    \"device_type\": \"iPhone\",\n    \"id\": 1,\n    \"lang\": null,\n    \"location_permissions\": \"True\",\n    \"os\": \"iPhone OS\",\n    \"os_version\": \"7.1.2\",\n    \"push_token\": \"APA...2\",\n    \"sdk_version\": \"1.3\",\n    \"user\": 2\n}"},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/v:version/devices/:id"},"body":"Regular API users can only list and retrieve devices (read-only). Devices, however, can update (PUT and PATCH) themselves using the SDK.","githubsync":"","sync_unique":"","user":"545383ac08d1800800473d8d","__v":0,"editedParams2":true,"link_external":false,"updates":[],"category":"5517d0d3b625a50d001260ac","editedParams":true,"title":"Get One device","childrenPages":[]}

getGet One device

Gets one registered device

Path Params

id:
integer
device id
Regular API users can only list and retrieve devices (read-only). Devices, however, can update (PUT and PATCH) themselves using the SDK.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Regular API users can only list and retrieve devices (read-only). Devices, however, can update (PUT and PATCH) themselves using the SDK.
{"_id":"55258b2458aa012100cefbf7","version":"54c8b329b3334c0d00236654","excerpt":"Sends a silent push notification to request data download","link_external":false,"slug":"wake-up-devices","api":{"params":[{"default":"","type":"int","name":"app_id","in":"body","_id":"55258b2458aa012100cefbf8","required":true,"desc":"app id"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\"detail\": \"Notification sent successfully\"\n}","name":""},{"status":400,"language":"json","code":"Application ID or user are not valid","name":""},{"language":"text","code":"Your request has been throttled.","status":429}]},"url":"/v:version/devices/notify","auth":"required","method":"post"},"body":"You can send a push notification to all your devices to request a data download. \nLimit is one request every 15 minutes to allow the queue to be managed.","title":"Wake Up Devices","link_url":"","order":2,"project":"545386120c09721000a069f5","__v":0,"createdAt":"2015-04-08T20:10:12.918Z","editedParams2":true,"githubsync":"","hidden":false,"sync_unique":"","type":"post","updates":[],"category":"5517d0d3b625a50d001260ac","editedParams":true,"user":"545383ac08d1800800473d8d","childrenPages":[]}

postWake Up Devices

Sends a silent push notification to request data download

Body Params

app_id:
required
integer
app id
You can send a push notification to all your devices to request a data download. Limit is one request every 15 minutes to allow the queue to be managed.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



You can send a push notification to all your devices to request a data download. Limit is one request every 15 minutes to allow the queue to be managed.
{"_id":"551fb809f656ee0d0047be1d","__v":3,"hidden":false,"link_external":false,"slug":"me-get","type":"get","updates":[],"body":"A user can have a logo and two corporate colors that can be used to build a dashboard or as a fallback style for coupons.","createdAt":"2015-04-04T10:08:09.743Z","link_url":"","order":0,"sync_unique":"","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"color_primary\": \"#000000\",\n    \"color_secondary\": \"#ffffff\",\n    \"email\": \"user@example.org\",\n    \"id\": 2,\n    \"language\": \"en\",\n    \"logo_url\": \"\",\n    \"username\": \"test_user\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/me"},"githubsync":"","project":"545386120c09721000a069f5","title":"Get Me","category":"5517d5e9f732e32100056ef8","excerpt":"Gets info about yourself","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","childrenPages":[]}

getGet Me

Gets info about yourself

A user can have a logo and two corporate colors that can be used to build a dashboard or as a fallback style for coupons.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



A user can have a logo and two corporate colors that can be used to build a dashboard or as a fallback style for coupons.
{"_id":"551fb98a9aa80d0d00e17764","link_external":false,"project":"545386120c09721000a069f5","slug":"me-partial-update","title":"Partial Update Me","body":"A user can have a logo and two corporate colors that can be used to build a dashboard or as a fallback style for coupons.","__v":0,"api":{"auth":"required","method":"patch","params":[{"_id":"551fb98a9aa80d0d00e17769","required":false,"desc":"A color in HTML notation: hash + 6 hex characters","default":"#000000","type":"string","name":"color_primary","in":"body"},{"in":"body","_id":"551fb98a9aa80d0d00e17768","required":false,"desc":"A color in HTML notation: hash + 6 hex characters","default":"#ffffff","type":"string","name":"color_secondary"},{"type":"string","name":"email","in":"body","_id":"551fb98a9aa80d0d00e17767","required":false,"desc":"","default":""},{"_id":"551fb98a9aa80d0d00e17766","required":false,"desc":"iso 639, 2 letter locale code. Only English (en) is allowed.","default":"en","type":"string","name":"language","in":"body"},{"_id":"551fb98a9aa80d0d00e17765","default":"","desc":"read only, a URL to the user's logo","name":"logo_url","required":false,"type":"string","in":"body"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"color_primary\": \"#000000\",\n    \"color_secondary\": \"#ffffff\",\n    \"email\": \"user@example.org\",\n    \"id\": 2,\n    \"language\": \"en\",\n    \"logo_url\": \"\",\n    \"username\": \"test_user\"\n}"},{"language":"json","code":"{}","name":"","status":400}]},"url":"/v:version/me"},"category":"5517d5e9f732e32100056ef8","editedParams":true,"excerpt":"Partially updates user info","githubsync":"","hidden":false,"order":1,"sync_unique":"","type":"patch","updates":[],"user":"545383ac08d1800800473d8d","createdAt":"2015-04-04T10:14:34.387Z","editedParams2":true,"link_url":"","version":"54c8b329b3334c0d00236654","childrenPages":[]}

patchPartial Update Me

Partially updates user info

Body Params

color_primary:
string#000000
A color in HTML notation: hash + 6 hex characters
color_secondary:
string#ffffff
A color in HTML notation: hash + 6 hex characters
email:
string
language:
stringen
iso 639, 2 letter locale code. Only English (en) is allowed.
logo_url:
string
read only, a URL to the user's logo
A user can have a logo and two corporate colors that can be used to build a dashboard or as a fallback style for coupons.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



A user can have a logo and two corporate colors that can be used to build a dashboard or as a fallback style for coupons.
{"_id":"551fb9cd4bf7e20d00aa34ed","link_url":"","project":"545386120c09721000a069f5","type":"put","updates":[],"body":"A user can have a logo and two corporate colors that can be used to build a dashboard or as a fallback style for coupons.","excerpt":"Updates user info","githubsync":"","order":2,"user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","editedParams":true,"editedParams2":true,"hidden":false,"link_external":false,"__v":0,"api":{"url":"/v:version/me","auth":"required","method":"put","params":[{"_id":"551fb98a9aa80d0d00e17769","required":false,"desc":"A color in HTML notation: hash + 6 hex characters","default":"#000000","type":"string","name":"color_primary","in":"body"},{"_id":"551fb98a9aa80d0d00e17768","required":false,"desc":"A color in HTML notation: hash + 6 hex characters","default":"#ffffff","type":"string","name":"color_secondary","in":"body"},{"_id":"551fb98a9aa80d0d00e17767","required":false,"desc":"","default":"","type":"string","name":"email","in":"body"},{"required":false,"desc":"iso 639, 2 letter locale code. Only English (en) is allowed.","default":"en","type":"string","name":"language","in":"body","_id":"551fb98a9aa80d0d00e17766"},{"type":"string","in":"body","_id":"551fb98a9aa80d0d00e17765","default":"","desc":"read only, a URL to the user's logo","name":"logo_url","required":false}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"color_primary\": \"#000000\",\n    \"color_secondary\": \"#ffffff\",\n    \"email\": \"user@example.org\",\n    \"id\": 2,\n    \"language\": \"en\",\n    \"logo_url\": \"\",\n    \"username\": \"test_user\"\n}"},{"status":400,"language":"json","code":"{}","name":""}]}},"category":"5517d5e9f732e32100056ef8","createdAt":"2015-04-04T10:15:41.273Z","slug":"update-me","sync_unique":"","title":"Update Me","childrenPages":[]}

putUpdate Me

Updates user info

Body Params

color_primary:
string#000000
A color in HTML notation: hash + 6 hex characters
color_secondary:
string#ffffff
A color in HTML notation: hash + 6 hex characters
email:
string
language:
stringen
iso 639, 2 letter locale code. Only English (en) is allowed.
logo_url:
string
read only, a URL to the user's logo
A user can have a logo and two corporate colors that can be used to build a dashboard or as a fallback style for coupons.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



A user can have a logo and two corporate colors that can be used to build a dashboard or as a fallback style for coupons.
{"_id":"551fbb6e9aa80d0d00e1776c","editedParams2":true,"updates":[],"api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"status\": \"Image uploaded successfully.\",\n    \"url\": \"https://movintracks-prod.s3.amazonaws.com/media/profiles/1_logo.png\"\n}"},{"language":"json","code":"{}","name":"","status":400}]},"url":"/v:version/me/pic_upload","auth":"required","method":"post","params":[{"desc":"local path to the file to be uploaded","default":"","type":"object","name":"logo","in":"body","_id":"5523d7547a36b22b00886533","required":true}]},"category":"5517d5e9f732e32100056ef8","type":"post","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","__v":3,"editedParams":true,"excerpt":"Uploads an image file to be used as a logo","slug":"me-pic-upload","sync_unique":"","body":"Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http -f POST https://api.movintracks.io/v2.0/me/pic_upload \\\"Authorization: Bearer d...3\\\" logo@user_logo.png\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]","createdAt":"2015-04-04T10:22:38.476Z","githubsync":"","order":3,"project":"545386120c09721000a069f5","title":"Me Upload Picture","hidden":false,"link_external":false,"link_url":"","childrenPages":[]}

postMe Upload Picture

Uploads an image file to be used as a logo

Body Params

logo:
required
object
local path to the file to be uploaded
Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms). [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/v2.0/me/pic_upload \"Authorization: Bearer d...3\" logo@user_logo.png", "language": "text" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms). [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/v2.0/me/pic_upload \"Authorization: Bearer d...3\" logo@user_logo.png", "language": "text" } ] } [/block]
{"_id":"55b75536aea7c8190058b88a","updates":[],"__v":1,"api":{"url":"/:version/fusion-apps-user","auth":"required","method":"get","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"[\n  {\n    \"username\":\"luke\",\n    \"oracle_endpoint\":\"https://example-crm.oracle.com:443/\",\n    \"id\":1\n  }\n]"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"body":"","category":"55b754d031bccb190081bf09","excerpt":"","project":"545386120c09721000a069f5","sync_unique":"","createdAt":"2015-07-28T10:11:02.920Z","type":"get","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","title":"Get Fusion Apps User","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"slug":"fusion-apps-user-get","childrenPages":[]}

getGet Fusion Apps User


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b755dc568be2230092b9cb","category":"55b754d031bccb190081bf09","createdAt":"2015-07-28T10:13:48.093Z","excerpt":"","link_external":false,"link_url":"","sync_unique":"","title":"Create Fusion Apps User","editedParams2":true,"githubsync":"","slug":"fusion-apps-user-create","type":"post","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","__v":0,"body":"","hidden":false,"order":1,"updates":[],"api":{"params":[{"default":"","type":"string","name":"username","in":"body","_id":"55b755a0568be2230092b9c9","required":true,"desc":""},{"required":true,"desc":"","default":"","type":"string","name":"password","in":"body","_id":"55b755a0568be2230092b9c8"},{"name":"oracle_endpoint","in":"body","_id":"55b755a0568be2230092b9c7","required":true,"desc":"","default":"","type":"string"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"username\":\"luke\",\n  \"oracle_endpoint\":\"https://example-crm.oracle.com:443/\",\n  \"id\":1\n}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/:version/fusion-apps-user","auth":"required","method":"post"},"editedParams":true,"project":"545386120c09721000a069f5","childrenPages":[]}

postCreate Fusion Apps User


Body Params

username:
required
string
password:
required
string
oracle_endpoint:
required
string

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b755a0568be2230092b9c6","category":"55b754d031bccb190081bf09","project":"545386120c09721000a069f5","version":"54c8b329b3334c0d00236654","__v":0,"editedParams":true,"editedParams2":true,"githubsync":"","hidden":false,"link_external":false,"link_url":"","sync_unique":"","title":"Update Fusion Apps User","updates":[],"api":{"method":"put","params":[{"desc":"","default":"","type":"int","name":"id","in":"path","_id":"55b755a0568be2230092b9ca","required":true},{"type":"string","name":"username","in":"body","_id":"55b755a0568be2230092b9c9","required":true,"desc":"","default":""},{"_id":"55b755a0568be2230092b9c8","required":true,"desc":"","default":"","type":"string","name":"password","in":"body"},{"required":true,"desc":"","default":"","type":"string","name":"oracle_endpoint","in":"body","_id":"55b755a0568be2230092b9c7"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"username\":\"luke\",\n  \"oracle_endpoint\":\"https://example-crm.oracle.com:443/\",\n  \"id\":1\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/:version/fusion-apps-user/:id","auth":"required"},"createdAt":"2015-07-28T10:12:48.438Z","excerpt":"","body":"","order":2,"slug":"fusion-apps-user-update","type":"put","user":"545383ac08d1800800473d8d","childrenPages":[]}

putUpdate Fusion Apps User


Path Params

id:
required
integer

Body Params

username:
required
string
password:
required
string
oracle_endpoint:
required
string

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b755f231bccb190081bf0c","editedParams2":true,"link_url":"","title":"Delete Fusion Apps User","user":"545383ac08d1800800473d8d","__v":0,"api":{"settings":"","url":"/:version/fusion-apps-user/:id","auth":"required","method":"delete","params":[{"_id":"55b755a0568be2230092b9ca","required":true,"desc":"","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"category":"55b754d031bccb190081bf09","hidden":false,"link_external":false,"slug":"fusion-apps-user-delete","body":"","editedParams":true,"sync_unique":"","updates":[],"project":"545386120c09721000a069f5","type":"delete","version":"54c8b329b3334c0d00236654","createdAt":"2015-07-28T10:14:10.387Z","excerpt":"","githubsync":"","order":3,"childrenPages":[]}

deleteDelete Fusion Apps User


Path Params

id:
required
integer

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"551fbd8df656ee0d0047be27","__v":1,"createdAt":"2015-04-04T10:31:41.339Z","hidden":false,"sync_unique":"","type":"get","version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"language":"json","code":"[\n  {\n    \"beacons\": [\n      {\n        \"major\": 1,\n        \"minor\": 1,\n        \"url\": \"https://api.movintracks.io/v2.0/beacons/1/\"\n      }\n    ],\n    \"id\": 1,\n    \"name\": \"Office, CEO Desk\",\n    \"zone\": 1\n  }\n]","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/points"},"link_url":"","project":"545386120c09721000a069f5","title":"Get All Points","body":"","category":"5517d140b625a50d001260af","excerpt":"Gets all points","link_external":false,"order":0,"githubsync":"","slug":"points-get-all","updates":[],"user":"545383ac08d1800800473d8d","childrenPages":[]}

getGet All Points

Gets all points

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551fbe42f656ee0d0047be2b","__v":1,"createdAt":"2015-04-04T10:34:42.449Z","editedParams2":true,"project":"545386120c09721000a069f5","slug":"points-get-one","link_url":"","title":"Get One Point","updates":[],"api":{"results":{"codes":[{"code":"{\n  \"beacons\": [\n    {\n      \"major\": 1,\n      \"minor\": 1,\n      \"url\": \"https://api.movintracks.io/v2.0/beacons/1/\"\n    }\n  ],\n  \"id\": 1,\n  \"name\": \"Office, CEO Desk\",\n  \"zone\": 1\n}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/points/:id","auth":"required","method":"get","params":[{"_id":"5523d8c3d326800d00224444","required":true,"desc":"point id","default":"","type":"int","name":"id","in":"path"}]},"body":"","editedParams":true,"excerpt":"Gets one point","githubsync":"","version":"54c8b329b3334c0d00236654","hidden":false,"link_external":false,"order":1,"sync_unique":"","category":"5517d140b625a50d001260af","type":"get","user":"545383ac08d1800800473d8d","childrenPages":[]}

getGet One Point

Gets one point

Path Params

id:
required
integer
point id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"551fc0ea623ff50d009b2b87","slug":"points-create","sync_unique":"","api":{"method":"post","params":[{"name":"name","in":"body","_id":"551fbf713439220d00f47282","required":true,"desc":"a human-readable name for the point","default":"","type":"string"},{"name":"zone","in":"body","_id":"551fbf713439220d00f47281","required":true,"desc":"zone id","default":"","type":"int"}],"results":{"codes":[{"status":200,"name":"","code":"{\n  \"beacons\": [\n    {\n      \"major\": 1,\n      \"minor\": 1,\n      \"url\": \"https://api.movintracks.io/v2.0/beacons/1\"\n    }\n  ],\n  \"id\": 1,\n  \"name\": \"Office, CEO Desk\",\n  \"zone\": 1\n}","language":"json"},{"code":"{}","language":"json","status":400,"name":""}]},"settings":"","url":"/v:version/points","auth":"required"},"editedParams2":true,"link_external":false,"type":"post","createdAt":"2015-04-04T10:46:02.037Z","editedParams":true,"excerpt":"Create a point","githubsync":"","hidden":false,"__v":2,"body":"Beacons have to be posted to their corresponding endpoint.","category":"5517d140b625a50d001260af","user":"545383ac08d1800800473d8d","project":"545386120c09721000a069f5","title":"Create Point","updates":[],"link_url":"","order":2,"version":"54c8b329b3334c0d00236654","childrenPages":[]}

postCreate Point

Create a point

Body Params

name:
required
string
a human-readable name for the point
zone:
required
integer
zone id
Beacons have to be posted to their corresponding endpoint.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Beacons have to be posted to their corresponding endpoint.
{"_id":"551fbeff4bf7e20d00aa34f8","__v":2,"createdAt":"2015-04-04T10:37:51.964Z","excerpt":"Partially updates a point","project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","category":"5517d140b625a50d001260af","link_external":false,"order":3,"updates":[],"type":"patch","body":"Beacons have to be posted to their corresponding endpoint.","editedParams":true,"editedParams2":true,"hidden":false,"link_url":"","slug":"point-partial-update","title":"Partial Update Point","api":{"method":"patch","params":[{"desc":"point id","default":"","type":"int","name":"id","in":"path","_id":"5523d9072813fd230030f689","required":true},{"type":"string","name":"name","in":"body","_id":"551fbf713439220d00f47282","required":false,"desc":"a human-readable name for the point","default":""},{"_id":"551fbf713439220d00f47281","required":false,"desc":"zone id","default":"","type":"int","name":"zone","in":"body"}],"results":{"codes":[{"language":"json","code":"{\n  \"beacons\": [\n    {\n      \"major\": 1,\n      \"minor\": 1,\n      \"url\": \"https://api.movintracks.io/v2.0/beacons/1\"\n    }\n  ],\n  \"id\": 1,\n  \"name\": \"Office, CEO Desk\",\n  \"zone\": 1\n}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/points/:id","auth":"required"},"githubsync":"","sync_unique":"","childrenPages":[]}

patchPartial Update Point

Partially updates a point

Path Params

id:
required
integer
point id

Body Params

name:
string
a human-readable name for the point
zone:
integer
zone id
Beacons have to be posted to their corresponding endpoint.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Beacons have to be posted to their corresponding endpoint.
{"_id":"551fbfbd4bf7e20d00aa34fb","body":"Beacons have to be posted to their corresponding endpoint.","createdAt":"2015-04-04T10:41:01.687Z","version":"54c8b329b3334c0d00236654","hidden":false,"order":4,"sync_unique":"","type":"put","githubsync":"","link_url":"","project":"545386120c09721000a069f5","__v":1,"api":{"params":[{"type":"int","name":"id","in":"path","_id":"5562de7887b5b11700c6182b","required":true,"desc":"point id","default":""},{"_id":"551fbf713439220d00f47282","required":true,"desc":"a human-readable name for the point","default":"","type":"string","name":"name","in":"body"},{"required":true,"desc":"zone id","default":"","type":"int","name":"zone","in":"body","_id":"551fbf713439220d00f47281"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"beacons\": [\n    {\n      \"major\": 1,\n      \"minor\": 1,\n      \"url\": \"https://api.movintracks.io/v2.0/beacons/1/\"\n    }\n  ],\n  \"id\": 1,\n  \"name\": \"Office, CEO Desk\",\n  \"zone\": 1\n}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/points/:id","auth":"required","method":"put"},"category":"5517d140b625a50d001260af","excerpt":"Update a point","slug":"points-update","title":"Update Point","updates":[],"editedParams":true,"editedParams2":true,"link_external":false,"user":"545383ac08d1800800473d8d","childrenPages":[]}

putUpdate Point

Update a point

Path Params

id:
required
integer
point id

Body Params

name:
required
string
a human-readable name for the point
zone:
required
integer
zone id
Beacons have to be posted to their corresponding endpoint.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Beacons have to be posted to their corresponding endpoint.
{"_id":"551fc057623ff50d009b2b85","hidden":false,"slug":"points-delete","title":"Delete Point","type":"delete","project":"545386120c09721000a069f5","sync_unique":"","updates":[],"__v":1,"api":{"auth":"required","method":"delete","params":[{"type":"int","name":"id","in":"path","_id":"5523d9281be9763500b286e5","required":false,"desc":"point id","default":""}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/points/:id"},"createdAt":"2015-04-04T10:43:35.767Z","editedParams2":true,"githubsync":"","link_url":"","user":"545383ac08d1800800473d8d","body":"","category":"5517d140b625a50d001260af","editedParams":true,"excerpt":"Delete a point","link_external":false,"order":5,"version":"54c8b329b3334c0d00236654","childrenPages":[]}

deleteDelete Point

Delete a point

Path Params

id:
integer
point id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"555f466b57fe0a0d00c8f484","__v":1,"body":"Returns paginated results for all visits, sorted by `entered_at` desc. `next` and `previous` are absolute URLs that point to the next and previous pages.\n\nFilters:\n* user\n\nOrdering:\n* entered_at\n* left_at\n\nExample: filter by `user` and order desc by `entered_at`\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http https://api.movintracks.io/v2.0/points/1/visits?user=2&ordering=-entered_at\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nOrder asc by `entered_at` and desc by `left_at`\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http https://api.movintracks.io/v2.0/points/1/visits?ordering=entered_at,-left_at\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","project":"545386120c09721000a069f5","slug":"point-visits-get-all","version":"54c8b329b3334c0d00236654","category":"5517d140b625a50d001260af","createdAt":"2015-05-22T15:08:27.674Z","editedParams":true,"link_external":false,"link_url":"","order":6,"updates":[],"api":{"auth":"required","examples":{"codes":[{"language":"text","code":"","name":""}]},"method":"get","params":[{"name":"id","in":"path","_id":"555f4734df54680d001803d9","required":false,"desc":"point id","default":"","type":"int"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"count\": 152,\n  \"next\": \"https://api.movintracks.io/v2.0/points/1/visits?page=2\",\n  \"previous\": null,\n  \"results\": [\n    {\n      \"entered_at\": \"2015-02-12T10:25:45Z\",\n      \"left_at\": \"2015-02-12T10:26:06Z\",\n      \"id\": 1,\n      \"user\": 2\n    },\n    ...\n  ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/:version/points/:id/visits"},"excerpt":"","githubsync":"","hidden":false,"sync_unique":"","title":"Get All Point Visits","user":"545383ac08d1800800473d8d","editedParams2":true,"type":"get","childrenPages":[]}

getGet All Point Visits


Path Params

id:
integer
point id
Returns paginated results for all visits, sorted by `entered_at` desc. `next` and `previous` are absolute URLs that point to the next and previous pages. Filters: * user Ordering: * entered_at * left_at Example: filter by `user` and order desc by `entered_at` [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/points/1/visits?user=2&ordering=-entered_at", "language": "shell" } ] } [/block] Order asc by `entered_at` and desc by `left_at` [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/points/1/visits?ordering=entered_at,-left_at", "language": "shell" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Returns paginated results for all visits, sorted by `entered_at` desc. `next` and `previous` are absolute URLs that point to the next and previous pages. Filters: * user Ordering: * entered_at * left_at Example: filter by `user` and order desc by `entered_at` [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/points/1/visits?user=2&ordering=-entered_at", "language": "shell" } ] } [/block] Order asc by `entered_at` and desc by `left_at` [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/points/1/visits?ordering=entered_at,-left_at", "language": "shell" } ] } [/block]
{"_id":"5523b62d54769b0d00d12fc2","__v":1,"api":{"url":"/v:version/social-profiles","auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"id\": 1,\n        \"name\": \"Twitter\",\n        \"url_social_profile\": \"https://twitter.com/movintracks\"\n    }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"createdAt":"2015-04-07T10:49:17.595Z","hidden":false,"link_external":false,"link_url":"","project":"545386120c09721000a069f5","githubsync":"","order":0,"slug":"social-profiles-get-all","updates":[],"body":"","excerpt":"Gets all social profiles","title":"Get All Social Profiles","version":"54c8b329b3334c0d00236654","category":"54e8b970a64fba0d008468a3","sync_unique":"","type":"get","user":"545383ac08d1800800473d8d","childrenPages":[]}

getGet All Social Profiles

Gets all social profiles

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5523b6bfc0c1af21004a8ef3","order":1,"updates":[],"version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"get","params":[{"name":"id","in":"path","_id":"5523b6bfc0c1af21004a8ef4","required":false,"desc":"social profile id","default":"","type":"int"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"[\n    {\n        \"id\": 1,\n        \"name\": \"Twitter\",\n        \"url_social_profile\": \"https://twitter.com/movintracks\"\n    }\n]"},{"language":"json","code":"{}","name":"","status":400}]},"url":"/v:version/social-profiles/:id"},"editedParams2":true,"hidden":false,"slug":"social-profiles-get-one","title":"Get One Social Profile","type":"get","__v":0,"createdAt":"2015-04-07T10:51:43.152Z","link_url":"","project":"545386120c09721000a069f5","body":"","githubsync":"","link_external":false,"user":"545383ac08d1800800473d8d","category":"54e8b970a64fba0d008468a3","editedParams":true,"excerpt":"Gets one social profile","sync_unique":"","childrenPages":[]}

getGet One Social Profile

Gets one social profile

Path Params

id:
integer
social profile id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5523b96f54769b0d00d12fc6","body":"","slug":"social-profiles-create","sync_unique":"","user":"545383ac08d1800800473d8d","__v":0,"api":{"url":"/v:version/social-profiles","auth":"required","method":"post","params":[{"_id":"5523b7d32f7a1b0d007af14b","required":false,"desc":"human-readable name of the social profile","default":"","type":"string","name":"name","in":"body"},{"_id":"5523b7d32f7a1b0d007af14a","required":false,"desc":"a URL to the social profile","default":"","type":"string","name":"url_social_profile","in":"body"}],"results":{"codes":[{"language":"json","code":"{\n  \"id\": 1,\n  \"name\": \"Twitter\",\n  \"url_social_profile\": \"https://twitter.com/movintracks\"\n}","name":"","status":201},{"code":"{}","name":"","status":400,"language":"json"}]}},"editedParams":true,"editedParams2":true,"hidden":false,"link_external":false,"category":"54e8b970a64fba0d008468a3","createdAt":"2015-04-07T11:03:11.119Z","githubsync":"","type":"post","updates":[],"excerpt":"Creates a social profile","link_url":"","order":2,"project":"545386120c09721000a069f5","title":"Create Social Profile","version":"54c8b329b3334c0d00236654","childrenPages":[]}

postCreate Social Profile

Creates a social profile

Body Params

name:
string
human-readable name of the social profile
url_social_profile:
string
a URL to the social profile

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5523b7d32f7a1b0d007af149","body":"","editedParams":true,"hidden":false,"link_external":false,"createdAt":"2015-04-07T10:56:19.449Z","category":"54e8b970a64fba0d008468a3","editedParams2":true,"order":3,"title":"Partial Update Social Profile","type":"patch","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"patch","params":[{"_id":"5523b6bfc0c1af21004a8ef4","required":true,"desc":"social profile id","default":"","type":"int","name":"id","in":"path"},{"_id":"5523b7d32f7a1b0d007af14b","required":false,"desc":"human-readable name of the social profile","default":"","type":"string","name":"name","in":"body"},{"in":"body","_id":"5523b7d32f7a1b0d007af14a","required":false,"desc":"a URL to the social profile","default":"","type":"string","name":"url_social_profile"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 1,\n  \"name\": \"Twitter\",\n  \"url_social_profile\": \"https://twitter.com/movintracks\"\n}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"url":"/v:version/social-profiles/:id"},"excerpt":"Partially updates a social profile","githubsync":"","link_url":"","project":"545386120c09721000a069f5","slug":"social-profiles-partial-update","sync_unique":"","__v":0,"version":"54c8b329b3334c0d00236654","updates":[],"childrenPages":[]}

patchPartial Update Social Profile

Partially updates a social profile

Path Params

id:
required
integer
social profile id

Body Params

name:
string
human-readable name of the social profile
url_social_profile:
string
a URL to the social profile

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5523b80f7a46cc1700026b1e","category":"54e8b970a64fba0d008468a3","editedParams":true,"githubsync":"","slug":"social-profiles-update","title":"Update Social Profile","user":"545383ac08d1800800473d8d","body":"","link_url":"","sync_unique":"","api":{"params":[{"default":"","type":"int","name":"id","in":"path","_id":"5523b6bfc0c1af21004a8ef4","required":true,"desc":"social profile id"},{"required":false,"desc":"human-readable name of the social profile","default":"","type":"string","name":"name","in":"body","_id":"5523b7d32f7a1b0d007af14b"},{"desc":"a URL to the social profile","default":"","type":"string","name":"url_social_profile","in":"body","_id":"5523b7d32f7a1b0d007af14a","required":false}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 1,\n  \"name\": \"Twitter\",\n  \"url_social_profile\": \"https://twitter.com/movintracks\"\n}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"url":"/v:version/social-profiles/:id","auth":"required","method":"put"},"createdAt":"2015-04-07T10:57:19.103Z","project":"545386120c09721000a069f5","updates":[],"excerpt":"Updates a social profile","link_external":false,"hidden":false,"order":4,"type":"put","version":"54c8b329b3334c0d00236654","__v":0,"editedParams2":true,"childrenPages":[]}

putUpdate Social Profile

Updates a social profile

Path Params

id:
required
integer
social profile id

Body Params

name:
string
human-readable name of the social profile
url_social_profile:
string
a URL to the social profile

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5523b9f5c0c1af21004a8f02","editedParams2":true,"excerpt":"Deletes a social profile","order":5,"project":"545386120c09721000a069f5","slug":"social-profiles-delete","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"delete","params":[{"type":"int","name":"id","in":"path","_id":"5523b6bfc0c1af21004a8ef4","required":true,"desc":"social profile id","default":""}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/social-profiles/:id"},"version":"54c8b329b3334c0d00236654","link_url":"","sync_unique":"","editedParams":true,"githubsync":"","link_external":false,"type":"delete","body":"","category":"54e8b970a64fba0d008468a3","hidden":false,"title":"Delete Social Profile","updates":[],"__v":0,"createdAt":"2015-04-07T11:05:25.936Z","childrenPages":[]}

deleteDelete Social Profile

Deletes a social profile

Path Params

id:
required
integer
social profile id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"552576c5a996d03100cc76cb","category":"552576903620312b008daedd","excerpt":"Upload a picture for a static page","hidden":false,"body":"Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http -f POST https://api.movintracks.io/v2.0/static-pages/1/pic_upload \\\"Authorization: Bearer ...\\\" img@snake.png\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","githubsync":"","link_url":"","order":0,"type":"post","updates":[],"version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"post","params":[{"_id":"55257454f162440d005df19a","required":true,"desc":"static page id","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"status\": \"Image uploaded successfully.\",\n  \"url\": \"https://movintracks-prod.s3.amazonaws.com/media/123.png\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/static-pages/:id/pic_upload"},"editedParams":true,"editedParams2":true,"sync_unique":"","title":"Upload Picture for Static Page","user":"545383ac08d1800800473d8d","__v":0,"createdAt":"2015-04-08T18:43:17.048Z","link_external":false,"project":"545386120c09721000a069f5","slug":"static-page-upload-picture","childrenPages":[]}

postUpload Picture for Static Page

Upload a picture for a static page

Path Params

id:
required
integer
static page id
Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms). [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/v2.0/static-pages/1/pic_upload \"Authorization: Bearer ...\" img@snake.png", "language": "shell" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms). [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/v2.0/static-pages/1/pic_upload \"Authorization: Bearer ...\" img@snake.png", "language": "shell" } ] } [/block]
{"_id":"552577d258aa012100cefbd9","createdAt":"2015-04-08T18:47:46.859Z","link_external":false,"sync_unique":"","type":"get","version":"54c8b329b3334c0d00236654","__v":0,"excerpt":"Gets all static pages","order":1,"updates":[],"user":"545383ac08d1800800473d8d","title":"Get All Static Pages","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"language":"json","code":"[\n  {\n    \"body\": \"<p>Beacons can be taped to cats</p>\",\n    \"id\": 1,\n    \"img_url\": \"\",\n    \"title\": \"Extra Extra!\",\n    \"webview\": \"https://api.movintracks.io/v2.0/webviews/static_pages/1\"\t\n  }\n]","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/static-pages"},"body":"","category":"552576903620312b008daedd","githubsync":"","hidden":false,"slug":"get-all-static-pages","link_url":"","project":"545386120c09721000a069f5","childrenPages":[]}

getGet All Static Pages

Gets all static pages

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b657dc6127b125003643fd","link_url":"","sync_unique":"","updates":[],"version":"54c8b329b3334c0d00236654","__v":0,"body":"","hidden":false,"slug":"get-one-static-page","title":"Get One Static Page","type":"get","editedParams2":true,"excerpt":"Gets all static pages","order":2,"user":"545383ac08d1800800473d8d","category":"552576903620312b008daedd","createdAt":"2015-07-27T16:10:04.466Z","githubsync":"","link_external":false,"project":"545386120c09721000a069f5","api":{"method":"get","params":[{"desc":"static page id","default":"","type":"int","name":"id","in":"path","_id":"55b657dc6127b125003643fe","required":true}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"body\": \"<p>Beacons can be taped to cats</p>\",\n  \"id\": 1,\n  \"img_url\": \"\",\n  \"title\": \"Extra Extra!\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/static_pages/1\"\t\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/static-pages/:id","auth":"required"},"editedParams":true,"childrenPages":[]}

getGet One Static Page

Gets all static pages

Path Params

id:
required
integer
static page id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b65326c2e909190073ec94","api":{"settings":"","url":"/v:version/static-pages","auth":"required","method":"post","params":[{"_id":"55b65326c2e909190073ec96","required":false,"desc":"","default":"","type":"string","name":"title","in":"body"},{"in":"body","_id":"55b65326c2e909190073ec95","required":false,"desc":"","default":"","type":"string","name":"body"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"body\": \"<p>Beacons can be taped to cats</p>\",\n  \"id\": 1,\n  \"img_url\": \"\",\n  \"title\": \"Extra Extra!\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/static_pages/1\"\t\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"createdAt":"2015-07-27T15:49:58.909Z","hidden":false,"order":3,"type":"post","updates":[],"__v":0,"body":"","category":"552576903620312b008daedd","editedParams":true,"link_external":false,"title":"Create Static Pages","user":"545383ac08d1800800473d8d","editedParams2":true,"githubsync":"","link_url":"","excerpt":"Creates a static page","project":"545386120c09721000a069f5","slug":"create-static-pages","sync_unique":"","version":"54c8b329b3334c0d00236654","childrenPages":[]}

postCreate Static Pages

Creates a static page

Body Params

title:
string
body:
string

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b6535c6127b125003643ee","link_url":"","__v":0,"api":{"auth":"required","method":"patch","params":[{"in":"path","_id":"55b6535c6127b125003643ef","required":true,"desc":"static page id","default":"","type":"int","name":"id"},{"type":"string","name":"title","in":"body","_id":"55b65326c2e909190073ec96","required":false,"desc":"","default":""},{"_id":"55b65326c2e909190073ec95","required":false,"desc":"","default":"","type":"string","name":"body","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"body\": \"<p>Beacons can be taped to cats</p>\",\n  \"id\": 1,\n  \"img_url\": \"\",\n  \"title\": \"Extra Extra!\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/static_pages/1\"\t\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/static-pages/:id"},"editedParams2":true,"excerpt":"Creates a static page","hidden":false,"link_external":false,"slug":"partial-update-static-pages","title":"Partial Update Static Pages","user":"545383ac08d1800800473d8d","body":"","editedParams":true,"githubsync":"","sync_unique":"","order":4,"type":"patch","category":"552576903620312b008daedd","createdAt":"2015-07-27T15:50:52.382Z","project":"545386120c09721000a069f5","updates":[],"version":"54c8b329b3334c0d00236654","childrenPages":[]}

patchPartial Update Static Pages

Creates a static page

Path Params

id:
required
integer
static page id

Body Params

title:
string
body:
string

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b657616127b125003643fc","category":"552576903620312b008daedd","hidden":false,"link_external":false,"title":"Update Static Pages","type":"put","version":"54c8b329b3334c0d00236654","__v":0,"api":{"method":"put","params":[{"name":"id","in":"path","_id":"55b6535c6127b125003643ef","required":true,"desc":"static page id","default":"","type":"int"},{"name":"title","in":"body","_id":"55b65326c2e909190073ec96","required":true,"desc":"","default":"","type":"string"},{"name":"body","in":"body","_id":"55b65326c2e909190073ec95","required":true,"desc":"","default":"","type":"string"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"body\": \"<p>Beacons can be taped to cats</p>\",\n  \"id\": 1,\n  \"img_url\": \"\",\n  \"title\": \"Extra Extra!\",\n  \"webview\": \"https://api.movintracks.io/v2.0/webviews/static_pages/1\"\t\n}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/static-pages/:id","auth":"required"},"body":"","editedParams2":true,"githubsync":"","order":5,"user":"545383ac08d1800800473d8d","createdAt":"2015-07-27T16:08:01.617Z","excerpt":"updates a static page","project":"545386120c09721000a069f5","slug":"update-static-pages","sync_unique":"","editedParams":true,"link_url":"","updates":[],"childrenPages":[]}

putUpdate Static Pages

updates a static page

Path Params

id:
required
integer
static page id

Body Params

title:
required
string
body:
required
string

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b65798c2e909190073eca5","project":"545386120c09721000a069f5","updates":[],"user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","category":"552576903620312b008daedd","excerpt":"","githubsync":"","type":"delete","hidden":false,"order":6,"title":"Delete Static Pages","slug":"delete-static-pages","sync_unique":"","__v":0,"body":"","editedParams2":true,"link_external":false,"link_url":"","api":{"auth":"required","method":"delete","params":[{"_id":"55b6535c6127b125003643ef","required":true,"desc":"static page id","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/static-pages/:id"},"createdAt":"2015-07-27T16:08:56.545Z","editedParams":true,"childrenPages":[]}

deleteDelete Static Pages


Path Params

id:
required
integer
static page id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"555f5d4fdf54680d0018047a","body":"","githubsync":"","hidden":false,"order":0,"project":"545386120c09721000a069f5","slug":"surveys-get-all","__v":2,"title":"Get all Surveys","link_external":false,"sync_unique":"","updates":[],"category":"5517d18e82f73b0d004026a5","excerpt":"Gets all surveys","version":"54c8b329b3334c0d00236654","link_url":"","type":"get","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"img_url\": \"\",\n    \"webview\": \"https://api.movintracks.io/v2.0/webviews/surveys/1\",\n    \"answers\": [\n      \"yes\",\n      \"no\",\n      \"I'm a cat\"\n    ],\n    \"id\": 1,\n    \"title\": \"Survey about pets\",\n    \"question\": \"Are you a cats person?\"\n  }\n]","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/surveys"},"createdAt":"2015-05-22T16:46:07.377Z","childrenPages":[]}

getGet all Surveys

Gets all surveys

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5525763a58aa012100cefbd7","sync_unique":"","createdAt":"2015-04-08T18:40:58.755Z","excerpt":"Upload a picture for a survey","githubsync":"","link_external":false,"project":"545386120c09721000a069f5","__v":0,"api":{"auth":"required","method":"post","params":[{"default":"","desc":"survey id","name":"id","required":true,"type":"int","in":"path","_id":"55257454f162440d005df19a"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"status\": \"Image uploaded successfully.\",\n  \"url\": \"https://movintracks-prod.s3.amazonaws.com/media/123.png\"\n}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/surveys/:id/pic_upload"},"category":"5517d18e82f73b0d004026a5","link_url":"","slug":"surveys-pic-upload","title":"Upload Picture for Survey","user":"545383ac08d1800800473d8d","body":"Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http -f POST https://api.movintracks.io/v2.0/actions-show-image/1/pic_upload \\\"Authorization: Bearer ...\\\" img@elephant.png\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","editedParams":true,"hidden":false,"order":1,"version":"54c8b329b3334c0d00236654","editedParams2":true,"type":"post","updates":[],"childrenPages":[]}

postUpload Picture for Survey

Upload a picture for a survey

Path Params

id:
required
integer
survey id
Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms). [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/v2.0/actions-show-image/1/pic_upload \"Authorization: Bearer ...\" img@elephant.png", "language": "shell" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Use form format to upload a logo, as explained in [HTTPie docs](https://github.com/jakubroztocil/httpie#file-upload-forms). [block:code] { "codes": [ { "code": "$ http -f POST https://api.movintracks.io/v2.0/actions-show-image/1/pic_upload \"Authorization: Bearer ...\" img@elephant.png", "language": "shell" } ] } [/block]
{"_id":"552580283620312b008daeee","updates":[],"user":"545383ac08d1800800473d8d","category":"5517d1a182f73b0d004026a7","excerpt":"","hidden":false,"sync_unique":"","title":"Get All Triggers Customer","type":"get","__v":0,"body":"","link_url":"","order":0,"api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"devices\": [1,2,4],\n    \"id\": 1,\n    \"type\": \"TriggerCustomer\",\n    \"url\": \"https://api.movintracks.io/v2.0/triggers-customer/1\"\n  }\n]","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/triggers-customer"},"link_external":false,"createdAt":"2015-04-08T19:23:20.319Z","githubsync":"","project":"545386120c09721000a069f5","slug":"triggers-customer-get-all","version":"54c8b329b3334c0d00236654","childrenPages":[]}

getGet All Triggers Customer


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"554262c7cbc48d0d00154580","updates":[],"category":"5517d1a182f73b0d004026a7","createdAt":"2015-04-30T17:13:43.087Z","githubsync":"","link_external":false,"sync_unique":"","title":"Get One Trigger Customer","api":{"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"devices\": [1,2,4],\n  \"id\": 1,\n  \"type\": \"TriggerCustomer\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-customer/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/triggers-customer/:id","auth":"required"},"link_url":"","project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","type":"get","__v":1,"body":"","excerpt":"","hidden":false,"order":1,"slug":"triggers-customer-get-one","childrenPages":[]}

getGet One Trigger Customer


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"554263fccbc48d0d00154584","hidden":false,"link_external":false,"link_url":"","slug":"create-trigger-customer","api":{"auth":"required","method":"post","params":[{"required":true,"desc":"Campaign id","default":"","type":"int","name":"campaign","in":"body","_id":"554263fccbc48d0d00154586"},{"name":"devices","in":"body","_id":"554263fccbc48d0d00154585","required":true,"desc":"Device ids","default":"","type":"array_int"}],"results":{"codes":[{"code":"{\n  \"campaign\": 1,\n  \"devices\": [1,2,4],\n  \"id\": 1,\n  \"type\": \"TriggerCustomer\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-customer/1\"\n}","name":"","status":201,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"url":"/v:version/triggers-customer"},"body":"","editedParams2":true,"excerpt":"Creates a trigger customer","title":"Create Trigger Customer","type":"post","version":"54c8b329b3334c0d00236654","category":"5517d1a182f73b0d004026a7","githubsync":"","updates":[],"user":"545383ac08d1800800473d8d","project":"545386120c09721000a069f5","sync_unique":"","__v":0,"createdAt":"2015-04-30T17:18:52.602Z","editedParams":true,"order":2,"childrenPages":[]}

postCreate Trigger Customer

Creates a trigger customer

Body Params

campaign:
required
integer
Campaign id
devices:
required
array of integers
Device ids

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"554265146592e60d00027cc1","githubsync":"","sync_unique":"","__v":0,"api":{"params":[{"type":"int","name":"id","in":"path","_id":"554265146592e60d00027cc2","required":true,"desc":"Trigger id","default":""},{"_id":"554263fccbc48d0d00154586","required":true,"desc":"Campaign id","default":"","type":"int","name":"campaign","in":"body"},{"in":"body","_id":"554263fccbc48d0d00154585","required":true,"desc":"Device ids","default":"","type":"array_int","name":"devices"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"devices\": [1,2,4],\n  \"id\": 1,\n  \"type\": \"TriggerCustomer\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-customer/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/triggers-customer/:id","auth":"required","method":"put"},"createdAt":"2015-04-30T17:23:32.538Z","editedParams":true,"editedParams2":true,"excerpt":"Updates a trigger customer","type":"put","updates":[],"title":"Update Trigger Customer","version":"54c8b329b3334c0d00236654","hidden":false,"order":3,"user":"545383ac08d1800800473d8d","body":"","category":"5517d1a182f73b0d004026a7","link_external":false,"link_url":"","project":"545386120c09721000a069f5","slug":"update-trigger-customer","childrenPages":[]}

putUpdate Trigger Customer

Updates a trigger customer

Path Params

id:
required
integer
Trigger id

Body Params

campaign:
required
integer
Campaign id
devices:
required
array of integers
Device ids

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55426549cbc48d0d00154587","api":{"auth":"required","method":"patch","params":[{"_id":"554265146592e60d00027cc2","required":true,"desc":"Trigger id","default":"","type":"int","name":"id","in":"path"},{"_id":"554263fccbc48d0d00154586","required":false,"desc":"Campaign id","default":"","type":"int","name":"campaign","in":"body"},{"in":"body","_id":"554263fccbc48d0d00154585","required":false,"desc":"Device ids","default":"","type":"array_int","name":"devices"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"devices\": [1,2,4],\n  \"id\": 1,\n  \"type\": \"TriggerCustomer\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-customer/1\"\n}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"url":"/v:version/triggers-customer/:id"},"githubsync":"","hidden":false,"slug":"partial-update-trigger-customer","updates":[],"__v":0,"body":"","createdAt":"2015-04-30T17:24:25.779Z","editedParams2":true,"project":"545386120c09721000a069f5","title":"Partial Update Trigger Customer","editedParams":true,"link_external":false,"type":"patch","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","category":"5517d1a182f73b0d004026a7","excerpt":"Partially updates a trigger customer","link_url":"","order":4,"sync_unique":"","childrenPages":[]}

patchPartial Update Trigger Customer

Partially updates a trigger customer

Path Params

id:
required
integer
Trigger id

Body Params

campaign:
integer
Campaign id
devices:
array of integers
Device ids

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5542657ccbc48d0d00154589","title":"Delete Trigger Customer","type":"delete","updates":[],"link_url":"","project":"545386120c09721000a069f5","slug":"delete-trigger-customer","version":"54c8b329b3334c0d00236654","excerpt":"Delete a trigger customer","hidden":false,"link_external":false,"body":"","order":5,"sync_unique":"","__v":0,"api":{"params":[{"default":"","type":"int","name":"id","in":"path","_id":"554265146592e60d00027cc2","required":true,"desc":"Trigger id"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/triggers-customer/:id","auth":"required","method":"delete"},"editedParams2":true,"githubsync":"","user":"545383ac08d1800800473d8d","category":"5517d1a182f73b0d004026a7","createdAt":"2015-04-30T17:25:16.603Z","editedParams":true,"childrenPages":[]}

deleteDelete Trigger Customer

Delete a trigger customer

Path Params

id:
required
integer
Trigger id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"55257ed258aa012100cefbea","__v":0,"api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"finish\": \"23:59:00\",\n    \"id\": 1,\n    \"start\": \"13:10:00\",\n    \"type\": \"TriggerInTimeRange\",\n    \"url\": \"https://api.movintracks.io/v2.0/triggers-in-time-range/1\"\n  }\n]","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/triggers-in-time-range"},"category":"5517d1a6b625a50d001260b0","createdAt":"2015-04-08T19:17:38.534Z","link_external":false,"slug":"triggers-in-time-range-get-all","title":"Get All Triggers In Time Range","updates":[],"user":"545383ac08d1800800473d8d","hidden":false,"order":0,"type":"get","body":"","excerpt":"","githubsync":"","link_url":"","project":"545386120c09721000a069f5","sync_unique":"","version":"54c8b329b3334c0d00236654","childrenPages":[]}

getGet All Triggers In Time Range


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555efffedf54680d001802ec","__v":0,"api":{"auth":"required","method":"post","params":[{"_id":"555efffedf54680d001802ef","required":true,"desc":"campaign id","default":"","type":"int","name":"campaign","in":"body"},{"required":true,"desc":"Time in format hh:mm:ss","default":"","type":"string","name":"start","in":"body","_id":"555efffedf54680d001802ee"},{"desc":"Time in format hh:mm:ss","default":"","type":"string","name":"finish","in":"body","_id":"555efffedf54680d001802ed","required":true}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"campaign\": 1,\n  \"finish\": \"23:59:00\",\n  \"id\": 1,\n  \"start\": \"13:10:00\",\n  \"type\": \"TriggerInTimeRange\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-in-time-range/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/triggers-in-time-range"},"editedParams":true,"link_url":"","category":"5517d1a6b625a50d001260b0","editedParams2":true,"excerpt":"","githubsync":"","link_external":false,"updates":[],"order":1,"slug":"create-triggers-in-time-range","title":"Create Triggers In Time Range","user":"545383ac08d1800800473d8d","body":"","createdAt":"2015-05-22T10:07:58.028Z","hidden":false,"project":"545386120c09721000a069f5","sync_unique":"","type":"post","version":"54c8b329b3334c0d00236654","childrenPages":[]}

postCreate Triggers In Time Range


Body Params

campaign:
required
integer
campaign id
start:
required
string
Time in format hh:mm:ss
finish:
required
string
Time in format hh:mm:ss

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55257fcb58aa012100cefbec","category":"5517d1aab625a50d001260b1","hidden":false,"link_url":"","sync_unique":"","title":"Get All Triggers Not Visited","body":"","excerpt":"","api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 1,\n    \"points\": [\n      1\n    ],\n    \"type\": \"TriggerNotVisited\",\n    \"url\": \"https://api.movintracks.io/v2.0/triggers-not-visited/1\"\n  }\n]","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/triggers-not-visited","auth":"required","method":"get","params":[]},"order":0,"project":"545386120c09721000a069f5","type":"get","updates":[],"user":"545383ac08d1800800473d8d","__v":0,"createdAt":"2015-04-08T19:21:47.280Z","githubsync":"","link_external":false,"slug":"triggers-not-visited-get-all","version":"54c8b329b3334c0d00236654","childrenPages":[]}

getGet All Triggers Not Visited


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f003d750e240d00cc30f6","__v":0,"category":"5517d1aab625a50d001260b1","editedParams":true,"project":"545386120c09721000a069f5","link_url":"","slug":"create-triggers-not-visited","updates":[],"api":{"method":"post","params":[{"name":"campaign","in":"body","_id":"555f003d750e240d00cc30f8","required":true,"desc":"campaign id","default":"","type":"int"},{"name":"points","in":"body","_id":"555f003d750e240d00cc30f7","required":true,"desc":"point ids","default":"","type":"array_int"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"points\": [\n    1\n  ],\n  \"type\": \"TriggerNotVisited\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-not-visited/1\"\n}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/triggers-not-visited","auth":"required"},"body":"","editedParams2":true,"hidden":false,"excerpt":"","githubsync":"","order":1,"user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","createdAt":"2015-05-22T10:09:01.117Z","link_external":false,"sync_unique":"","title":"Create Triggers Not Visited","type":"post","childrenPages":[]}

postCreate Triggers Not Visited


Body Params

campaign:
required
integer
campaign id
points:
required
array of integers
point ids

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55257e34f162440d005df1b0","__v":0,"api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"direction\": \"enter\",\n    \"distance\": \"far\",\n    \"id\": 1,\n    \"points\": [\n      1\n    ],\n    \"type\": \"TriggerOnVisit\",\n    \"url\": \"https://api.movintracks.io/v2.0/triggers-on-visit/1\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/triggers-on-visit"},"link_external":false,"link_url":"","project":"545386120c09721000a069f5","body":"","order":0,"createdAt":"2015-04-08T19:15:00.440Z","excerpt":"","sync_unique":"","type":"get","updates":[],"version":"54c8b329b3334c0d00236654","category":"5517d1b0f732e32100056ef3","githubsync":"","hidden":false,"slug":"triggers-on-visit-get-all","title":"Get All Triggers On Visit","user":"545383ac08d1800800473d8d","childrenPages":[]}

getGet All Triggers On Visit


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b658d4c2e909190073ecb4","api":{"method":"get","params":[{"desc":"trigger id","default":"","type":"int","name":"id","in":"path","_id":"55b658d4c2e909190073ecb5","required":true}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"direction\": \"enter\",\n  \"distance\": \"far\",\n  \"id\": 1,\n  \"points\": [\n    1\n  ],\n  \"type\": \"TriggerOnVisit\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-on-visit/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/triggers-on-visit/:id","auth":"required"},"title":"Get One Triggers On Visit","link_external":false,"slug":"get-one-triggers-on-visit","sync_unique":"","version":"54c8b329b3334c0d00236654","link_url":"","order":1,"category":"5517d1b0f732e32100056ef3","createdAt":"2015-07-27T16:14:12.961Z","editedParams":true,"excerpt":"","githubsync":"","updates":[],"user":"545383ac08d1800800473d8d","__v":0,"body":"","editedParams2":true,"hidden":false,"project":"545386120c09721000a069f5","type":"get","childrenPages":[]}

getGet One Triggers On Visit


Path Params

id:
required
integer
trigger id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5559aec5c9cbc70d003db201","githubsync":"","project":"545386120c09721000a069f5","sync_unique":"","type":"post","user":"545383ac08d1800800473d8d","createdAt":"2015-05-18T09:20:05.759Z","editedParams":true,"slug":"create-triggers-on-visit","title":"Create Triggers On Visit","updates":[],"body":"","excerpt":"","link_url":"","order":2,"api":{"method":"post","params":[{"name":"campaign","in":"body","_id":"5559b06107b1710d0055fa1b","required":true,"desc":"campaign id","default":"","type":"int"},{"desc":"point ids","default":"","type":"array_int","name":"points","in":"body","_id":"5559b06107b1710d0055fa1a","required":true},{"default":"enter","type":"string","name":"direction","in":"body","_id":"5559b06107b1710d0055fa19","required":false,"desc":"options: enter, leave"},{"in":"body","_id":"5559b06107b1710d0055fa18","required":false,"desc":"options: immediate, near, far. relative to the received power of the beacon in a device.","default":"far","type":"string","name":"distance"}],"results":{"codes":[{"name":"","code":"{\n  \"campaign\": 1,\n  \"direction\": \"enter\",\n  \"distance\": \"far\",\n  \"id\": 1,\n  \"points\": [\n    1\n  ],\n  \"type\": \"TriggerOnVisit\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-on-visit/1\"\n}","language":"json","status":201},{"name":"","code":"{}","language":"json","status":400}]},"url":"/v:version/triggers-on-visit","auth":"required"},"category":"5517d1b0f732e32100056ef3","editedParams2":true,"hidden":false,"link_external":false,"version":"54c8b329b3334c0d00236654","__v":2,"childrenPages":[]}

postCreate Triggers On Visit


Body Params

campaign:
required
integer
campaign id
points:
required
array of integers
point ids
direction:
stringenter
options: enter, leave
distance:
stringfar
options: immediate, near, far. relative to the received power of the beacon in a device.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b6585f6127b125003643ff","title":"Create Triggers On Visit","type":"patch","__v":0,"createdAt":"2015-07-27T16:12:15.108Z","editedParams2":true,"link_url":"","user":"545383ac08d1800800473d8d","body":"","editedParams":true,"githubsync":"","updates":[],"order":3,"version":"54c8b329b3334c0d00236654","api":{"params":[{"type":"int","name":"id","in":"path","_id":"55b6585f6127b12500364400","required":true,"desc":"trigger id","default":""},{"_id":"5559b06107b1710d0055fa1b","required":false,"desc":"campaign id","default":"","type":"int","name":"campaign","in":"body"},{"_id":"5559b06107b1710d0055fa1a","required":false,"desc":"point ids","default":"","type":"array_int","name":"points","in":"body"},{"_id":"5559b06107b1710d0055fa19","required":false,"desc":"options: enter, leave","default":"enter","type":"string","name":"direction","in":"body"},{"_id":"5559b06107b1710d0055fa18","required":false,"desc":"options: immediate, near, far. relative to the received power of the beacon in a device.","default":"far","type":"string","name":"distance","in":"body"}],"results":{"codes":[{"name":"","code":"{\n  \"campaign\": 1,\n  \"direction\": \"enter\",\n  \"distance\": \"far\",\n  \"id\": 1,\n  \"points\": [\n    1\n  ],\n  \"type\": \"TriggerOnVisit\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-on-visit/1\"\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/v:version/triggers-on-visit/:id","auth":"required","method":"patch"},"excerpt":"","link_external":false,"sync_unique":"","category":"5517d1b0f732e32100056ef3","hidden":false,"project":"545386120c09721000a069f5","slug":"create-triggers-on-visit-1","childrenPages":[]}

patchCreate Triggers On Visit


Path Params

id:
required
integer
trigger id

Body Params

campaign:
integer
campaign id
points:
array of integers
point ids
direction:
stringenter
options: enter, leave
distance:
stringfar
options: immediate, near, far. relative to the received power of the beacon in a device.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b65888c2e909190073ecb3","__v":0,"body":"","githubsync":"","link_external":false,"link_url":"","project":"545386120c09721000a069f5","category":"5517d1b0f732e32100056ef3","excerpt":"","order":4,"title":"Create Triggers On Visit","type":"put","version":"54c8b329b3334c0d00236654","createdAt":"2015-07-27T16:12:56.231Z","hidden":false,"slug":"create-triggers-on-visit-2","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"put","params":[{"_id":"55b6585f6127b12500364400","required":true,"desc":"trigger id","default":"","type":"int","name":"id","in":"path"},{"in":"body","_id":"5559b06107b1710d0055fa1b","required":true,"desc":"campaign id","default":"","type":"int","name":"campaign"},{"default":"","type":"array_int","name":"points","in":"body","_id":"5559b06107b1710d0055fa1a","required":true,"desc":"point ids"},{"required":true,"desc":"options: enter, leave","default":"enter","type":"string","name":"direction","in":"body","_id":"5559b06107b1710d0055fa19"},{"name":"distance","in":"body","_id":"5559b06107b1710d0055fa18","required":true,"desc":"options: immediate, near, far. relative to the received power of the beacon in a device.","default":"far","type":"string"}],"results":{"codes":[{"name":"","code":"{\n  \"campaign\": 1,\n  \"direction\": \"enter\",\n  \"distance\": \"far\",\n  \"id\": 1,\n  \"points\": [\n    1\n  ],\n  \"type\": \"TriggerOnVisit\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-on-visit/1\"\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/v:version/triggers-on-visit/:id"},"editedParams":true,"editedParams2":true,"sync_unique":"","updates":[],"childrenPages":[]}

putCreate Triggers On Visit


Path Params

id:
required
integer
trigger id

Body Params

campaign:
required
integer
campaign id
points:
required
array of integers
point ids
direction:
required
stringenter
options: enter, leave
distance:
required
stringfar
options: immediate, near, far. relative to the received power of the beacon in a device.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55b658ad6127b12500364403","createdAt":"2015-07-27T16:13:33.794Z","link_external":false,"version":"54c8b329b3334c0d00236654","slug":"create-triggers-on-visit-3","title":"Create Triggers On Visit","updates":[],"user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"delete","params":[{"_id":"55b6585f6127b12500364400","required":true,"desc":"trigger id","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"name":"","code":"","language":"json","status":204},{"language":"json","status":400,"name":"","code":"{}"}]},"settings":"","url":"/v:version/triggers-on-visit/:id"},"editedParams":true,"githubsync":"","hidden":false,"project":"545386120c09721000a069f5","body":"","excerpt":"","link_url":"","sync_unique":"","type":"delete","__v":0,"category":"5517d1b0f732e32100056ef3","editedParams2":true,"order":5,"childrenPages":[]}

deleteCreate Triggers On Visit


Path Params

id:
required
integer
trigger id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"555ef73a750e240d00cc30d0","excerpt":"","project":"545386120c09721000a069f5","type":"get","user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"direction\": \"enter\",\n    \"id\": 1,\n    \"type\": \"TriggerOnVisitZone\",\n    \"url\": \"https://api.movintracks.io/v2.0/triggers-on-visit-zone/1\",\n    \"zones\": [\n      1\n    ]\n  }\n]\n  ","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/triggers-on-visit-zone"},"category":"555ef71f57fe0a0d00c8f3a9","title":"Get All Triggers On Visit Zone","version":"54c8b329b3334c0d00236654","__v":2,"githubsync":"","link_url":"","sync_unique":"","link_external":false,"order":0,"slug":"triggers-on-visit-zone-get-all","updates":[],"body":"","createdAt":"2015-05-22T09:30:34.095Z","hidden":false,"childrenPages":[]}

getGet All Triggers On Visit Zone


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"5562ddc122ce3921003a8d48","excerpt":"Gets one trigger of type on visit zone","api":{"auth":"required","method":"get","params":[{"required":false,"desc":"trigger on visit id","default":"","type":"int","name":"id","in":"path","_id":"5562ddc122ce3921003a8d49"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"direction\": \"enter\",\n  \"id\": 1,\n  \"type\": \"TriggerOnVisitZone\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-on-visit-zone/1\",\n  \"zones\": [\n    1\n  ]\n}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/v:version/triggers-on-visit-zone/:id"},"category":"555ef71f57fe0a0d00c8f3a9","hidden":false,"link_external":false,"slug":"trigger-on-visit-zone-get-one","githubsync":"","order":1,"title":"Get One Trigger On Visit Zone","version":"54c8b329b3334c0d00236654","__v":0,"createdAt":"2015-05-25T08:30:57.621Z","editedParams2":true,"link_url":"","project":"545386120c09721000a069f5","sync_unique":"","type":"get","updates":[],"body":"","editedParams":true,"user":"545383ac08d1800800473d8d","childrenPages":[]}

getGet One Trigger On Visit Zone

Gets one trigger of type on visit zone

Path Params

id:
integer
trigger on visit id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555ef9a857fe0a0d00c8f3b5","body":"","order":2,"title":"Create Triggers On Visit Zone","type":"post","__v":1,"api":{"params":[{"default":"","type":"int","name":"campaign","in":"body","_id":"5559b06107b1710d0055fa1b","required":true,"desc":"campaign id"},{"in":"body","_id":"5559b06107b1710d0055fa1a","required":true,"desc":"zone ids","default":"","type":"array_int","name":"zones"},{"default":"enter","type":"string","name":"direction","in":"body","_id":"5559b06107b1710d0055fa19","required":false,"desc":"options: enter, leave"}],"results":{"codes":[{"name":"","code":"{\n  \"campaign\": 1,\n  \"direction\": \"enter\",\n  \"id\": 1,\n  \"zones\": [\n    1\n  ],\n  \"type\": \"TriggerOnVisitZone\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-on-visit-zone/1\"\n}","language":"json","status":201},{"language":"json","status":400,"name":"","code":"{}"}]},"url":"/v:version/triggers-on-visit-zone","auth":"required","method":"post"},"category":"555ef71f57fe0a0d00c8f3a9","createdAt":"2015-05-22T09:40:56.067Z","editedParams":true,"githubsync":"","link_url":"","project":"545386120c09721000a069f5","updates":[],"user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","excerpt":"","hidden":false,"link_external":false,"slug":"triggers-on-visit-zone-create","sync_unique":"","editedParams2":true,"childrenPages":[]}

postCreate Triggers On Visit Zone


Body Params

campaign:
required
integer
campaign id
zones:
required
array of integers
zone ids
direction:
stringenter
options: enter, leave

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f530557fe0a0d00c8f4b0","sync_unique":"","__v":0,"api":{"params":[{"default":"","type":"int","name":"id","in":"path","_id":"555f530557fe0a0d00c8f4b1","required":true,"desc":"trigger on visit zone id"},{"in":"body","_id":"5559b06107b1710d0055fa1b","required":true,"desc":"campaign id","default":"","type":"int","name":"campaign"},{"default":"","type":"array_int","name":"zones","in":"body","_id":"5559b06107b1710d0055fa1a","required":true,"desc":"zone ids"},{"required":false,"desc":"options: enter, leave","default":"enter","type":"string","name":"direction","in":"body","_id":"5559b06107b1710d0055fa19"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"campaign\": 1,\n  \"direction\": \"enter\",\n  \"id\": 1,\n  \"zones\": [\n    1\n  ],\n  \"type\": \"TriggerOnVisitZone\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-on-visit-zone/1\"\n}"},{"name":"","code":"{}","language":"json","status":400}]},"url":"/v:version/triggers-on-visit-zone/:id","auth":"required","method":"put"},"editedParams2":true,"githubsync":"","link_external":false,"slug":"triggers-on-visit-zone-update","updates":[],"body":"","category":"555ef71f57fe0a0d00c8f3a9","createdAt":"2015-05-22T16:02:13.832Z","editedParams":true,"hidden":false,"type":"put","order":3,"user":"545383ac08d1800800473d8d","excerpt":"","link_url":"","project":"545386120c09721000a069f5","title":"Update Triggers On Visit Zone","version":"54c8b329b3334c0d00236654","childrenPages":[]}

putUpdate Triggers On Visit Zone


Path Params

id:
required
integer
trigger on visit zone id

Body Params

campaign:
required
integer
campaign id
zones:
required
array of integers
zone ids
direction:
stringenter
options: enter, leave

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f532d750e240d00cc31b3","excerpt":"","githubsync":"","hidden":false,"link_external":false,"body":"","category":"555ef71f57fe0a0d00c8f3a9","editedParams":true,"link_url":"","order":4,"slug":"triggers-on-visit-zone-partial-update","version":"54c8b329b3334c0d00236654","editedParams2":true,"project":"545386120c09721000a069f5","sync_unique":"","title":"Partial Update Triggers On Visit Zone","type":"patch","user":"545383ac08d1800800473d8d","createdAt":"2015-05-22T16:02:53.047Z","api":{"auth":"required","method":"patch","params":[{"type":"int","name":"id","in":"path","_id":"555f530557fe0a0d00c8f4b1","required":true,"desc":"trigger on visit zone id","default":""},{"_id":"5559b06107b1710d0055fa1b","default":"","desc":"campaign id","name":"campaign","required":false,"type":"int","in":"body"},{"_id":"5559b06107b1710d0055fa1a","default":"","desc":"zone ids","name":"zones","required":false,"type":"array_int","in":"body"},{"required":false,"desc":"options: enter, leave","default":"enter","type":"string","name":"direction","in":"body","_id":"5559b06107b1710d0055fa19"}],"results":{"codes":[{"status":200,"name":"","code":"{\n  \"campaign\": 1,\n  \"direction\": \"enter\",\n  \"id\": 1,\n  \"zones\": [\n    1\n  ],\n  \"type\": \"TriggerOnVisitZone\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-on-visit-zone/1\"\n}","language":"json"},{"name":"","code":"{}","language":"json","status":400}]},"url":"/v:version/triggers-on-visit-zone/:id"},"updates":[],"__v":0,"childrenPages":[]}

patchPartial Update Triggers On Visit Zone


Path Params

id:
required
integer
trigger on visit zone id

Body Params

campaign:
integer
campaign id
zones:
array of integers
zone ids
direction:
stringenter
options: enter, leave

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f5366df54680d001803fe","api":{"method":"delete","params":[{"desc":"trigger on visit zone id","default":"","type":"int","name":"id","in":"path","_id":"555f530557fe0a0d00c8f4b1","required":true}],"results":{"codes":[{"name":"","code":"","language":"json","status":204},{"name":"","code":"{}","language":"json","status":400}]},"url":"/v:version/triggers-on-visit-zone/:id","auth":"required"},"link_external":false,"project":"545386120c09721000a069f5","slug":"triggers-on-visit-zone-delete","category":"555ef71f57fe0a0d00c8f3a9","githubsync":"","order":5,"sync_unique":"","__v":0,"body":"","createdAt":"2015-05-22T16:03:50.688Z","editedParams":true,"editedParams2":true,"link_url":"","user":"545383ac08d1800800473d8d","excerpt":"","hidden":false,"title":"Delete Triggers On Visit Zone","type":"delete","updates":[],"version":"54c8b329b3334c0d00236654","childrenPages":[]}

deleteDelete Triggers On Visit Zone


Path Params

id:
required
integer
trigger on visit zone id

Definition

{{ api_url }}{{ page_api_url }}


{"_id":"55257e89658aa80d00297152","category":"5517d1b5f732e32100056ef4","createdAt":"2015-04-08T19:16:25.386Z","link_url":"","slug":"triggers-social-follow-get-all","type":"get","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 1,\n    \"social_profile\": 1,\n    \"type\": \"TriggerSocialFollow\",\n    \"url\": \"https://api.movintracks.io/v2.0/triggers-social-follow/1\"\n  }\n]"},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/triggers-social-follow"},"githubsync":"","link_external":false,"project":"545386120c09721000a069f5","sync_unique":"","updates":[],"user":"545383ac08d1800800473d8d","body":"","order":0,"title":"Get All Triggers Social Follow","__v":0,"excerpt":"","hidden":false,"version":"54c8b329b3334c0d00236654","childrenPages":[]}

getGet All Triggers Social Follow


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f03c357fe0a0d00c8f3cc","slug":"create-triggers-social-follow","excerpt":"","api":{"params":[{"default":"","type":"int","name":"campaign","in":"body","_id":"555f03c357fe0a0d00c8f3ce","required":true,"desc":"campaign id"},{"in":"body","_id":"555f03c357fe0a0d00c8f3cd","required":true,"desc":"social profile id","default":"","type":"int","name":"social_profile"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"social_profile\": 1,\n  \"type\": \"TriggerSocialFollow\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-social-follow/1\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/triggers-social-follow","auth":"required","method":"post"},"body":"","category":"5517d1b5f732e32100056ef4","sync_unique":"","updates":[],"githubsync":"","hidden":false,"order":1,"type":"post","editedParams2":true,"createdAt":"2015-05-22T10:24:03.098Z","editedParams":true,"link_external":false,"link_url":"","project":"545386120c09721000a069f5","title":"Create Triggers Social Follow","user":"545383ac08d1800800473d8d","__v":0,"version":"54c8b329b3334c0d00236654","childrenPages":[]}

postCreate Triggers Social Follow


Body Params

campaign:
required
integer
campaign id
social_profile:
required
integer
social profile id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"55257f4e658aa80d00297154","createdAt":"2015-04-08T19:19:42.478Z","excerpt":"","user":"545383ac08d1800800473d8d","__v":0,"body":"","githubsync":"","link_url":"","project":"545386120c09721000a069f5","api":{"url":"/v:version/triggers-timeout","auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 1,\n    \"interval_in_seconds\": 600,\n    \"type\": \"TriggerTimeout\",\n    \"url\": \"https://api.movintracks.io/v2.0/triggers-timeout/1\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"hidden":false,"link_external":false,"sync_unique":"","type":"get","category":"5517d1ba82f73b0d004026a8","order":0,"slug":"triggers-timeout-get-all","title":"Get All Triggers Timeout","updates":[],"version":"54c8b329b3334c0d00236654","childrenPages":[]}

getGet All Triggers Timeout


Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f0423750e240d00cc3108","type":"post","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","__v":0,"editedParams":true,"editedParams2":true,"hidden":false,"api":{"auth":"required","method":"post","params":[{"desc":"id","default":"","type":"int","name":"campaign","in":"body","_id":"555f0423750e240d00cc310a","required":true},{"default":"","type":"int","name":"interval_in_seconds","in":"body","_id":"555f0423750e240d00cc3109","required":true,"desc":"timeout interval in seconds"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"campaign\": 1,\n  \"id\": 1,\n  \"interval_in_seconds\": 600,\n  \"type\": \"TriggerTimeout\",\n  \"url\": \"https://api.movintracks.io/v2.0/triggers-timeout/1\"\n}"},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/triggers-timeout"},"category":"5517d1ba82f73b0d004026a8","githubsync":"","sync_unique":"","order":1,"project":"545386120c09721000a069f5","slug":"create-triggers-timeout","title":"Create Triggers Timeout","body":"","createdAt":"2015-05-22T10:25:39.725Z","link_external":false,"link_url":"","excerpt":"","updates":[],"childrenPages":[]}

postCreate Triggers Timeout


Body Params

campaign:
required
integer
id
interval_in_seconds:
required
integer
timeout interval in seconds

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"552580cea996d03100cc76d7","title":"Get All vCards","excerpt":"","link_external":false,"createdAt":"2015-04-08T19:26:06.204Z","hidden":false,"link_url":"","order":0,"slug":"get-all-vcards","updates":[],"api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"address\": \"Rue Wiertz 60\",\n    \"city\": \"Brussels\",\n    \"company\": \"Movintracks\",\n    \"country\": \"Belgium\",\n    \"email\": \"example@example.org\",\n    \"family_name\": \"Smith\",\n    \"first_name\": \"John\",\n    \"id\": 1,\n    \"phone\": \"1234567\",\n    \"post_code\": \"1047\",\n    \"website\": \"http://www.example.org\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/vcards"},"body":"","user":"545383ac08d1800800473d8d","sync_unique":"","githubsync":"","project":"545386120c09721000a069f5","type":"get","version":"54c8b329b3334c0d00236654","__v":0,"category":"5517d1d382f73b0d004026a9","childrenPages":[]}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"555f0553750e240d00cc310d","api":{"method":"post","params":[{"desc":"","default":"","type":"string","name":"family_name","in":"body","_id":"555f0553750e240d00cc3117","required":false},{"type":"string","name":"first_name","in":"body","_id":"555f0553750e240d00cc3116","required":false,"desc":"","default":""},{"_id":"555f0553750e240d00cc3115","required":false,"desc":"Postal address","default":"","type":"string","name":"address","in":"body"},{"_id":"555f0553750e240d00cc3114","required":false,"desc":"","default":"","type":"string","name":"email","in":"body"},{"_id":"555f0553750e240d00cc3113","required":false,"desc":"","default":"","type":"string","name":"phone","in":"body"},{"in":"body","_id":"555f0553750e240d00cc3112","required":false,"desc":"","default":"","type":"string","name":"website"},{"default":"","type":"string","name":"company","in":"body","_id":"555f0553750e240d00cc3111","required":false,"desc":""},{"in":"body","_id":"555f0553750e240d00cc3110","required":false,"desc":"","default":"","type":"string","name":"city"},{"type":"string","name":"post_code","in":"body","_id":"555f0553750e240d00cc310f","required":false,"desc":"","default":""},{"_id":"555f0553750e240d00cc310e","required":false,"desc":"","default":"","type":"string","name":"country","in":"body"}],"results":{"codes":[{"code":"{\n  \"address\": \"Rue Wiertz 60\",\n  \"city\": \"Brussels\",\n  \"company\": \"Movintracks\",\n  \"country\": \"Belgium\",\n  \"email\": \"example@example.org\",\n  \"family_name\": \"Smith\",\n  \"first_name\": \"John\",\n  \"id\": 1,\n  \"phone\": \"1234567\",\n  \"post_code\": \"1047\",\n  \"website\": \"http://www.example.org\"\n}","name":"","status":201,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/vcards","auth":"required"},"createdAt":"2015-05-22T10:30:43.089Z","link_url":"","project":"545386120c09721000a069f5","type":"post","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","editedParams":true,"link_external":false,"order":1,"slug":"create-vcards","body":"","sync_unique":"","title":"Create vCards","updates":[],"__v":0,"category":"5517d1d382f73b0d004026a9","editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"childrenPages":[]}

postCreate vCards


Body Params

family_name:
string
first_name:
string
address:
string
Postal address
email:
string
phone:
string
website:
string
company:
string
city:
string
post_code:
string
country:
string

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"54c8b32ab3334c0d00236658","slug":"zones-get-all","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","category":"54d3680f87ea950d00f1bcbb","excerpt":"Get all zones","hidden":false,"link_url":"","project":"545386120c09721000a069f5","title":"Get All Zones","__v":15,"api":{"url":"/v:version/zones","auth":"required","method":"get","params":[],"results":{"codes":[{"name":"","code":"[\n  {\n    \"name\":\"Sample Zone 1\",\n    \"radius\":12,\n    \"lat\":42.456,\n    \"lng\":2.478\n  }\n]","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"sync_unique":"","type":"get","updates":[],"body":"","createdAt":"2014-11-27T17:16:12.104Z","githubsync":"","link_external":false,"order":0,"childrenPages":[]}

getGet All Zones

Get all zones

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"54d36b995616470d0013ccf4","order":1,"slug":"zones-get-one","sync_unique":"","title":"Get One Zone","__v":0,"body":"","link_external":false,"link_url":"","user":"545383ac08d1800800473d8d","githubsync":"","type":"get","project":"545386120c09721000a069f5","version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"get","params":[{"required":true,"type":"int","in":"path","_id":"54d36b995616470d0013ccf5","default":"","desc":"zone id","name":"id"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"name\":\"Sample Zone 1\",\n  \"radius\":12,\n  \"lat\":42.456,\n  \"lng\":2.478\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/zones/:id"},"createdAt":"2015-02-05T13:09:45.301Z","editedParams2":true,"hidden":false,"updates":[],"category":"54d3680f87ea950d00f1bcbb","editedParams":true,"excerpt":"","childrenPages":[]}

getGet One Zone


Path Params

id:
required
integer
zone id

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"54c8d7890174630d00efa843","link_url":"","order":2,"user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","category":"54d3680f87ea950d00f1bcbb","createdAt":"2015-01-28T12:35:21.487Z","editedParams":true,"excerpt":"Create a zone","link_external":false,"project":"545386120c09721000a069f5","updates":[],"api":{"auth":"required","method":"post","params":[{"name":"name","required":true,"type":"string","in":"body","_id":"54ca1ff6f4c2b70d008597a3","default":"","desc":"A human readable name for the zone, e.g. \"Mountain View Office\""},{"in":"body","_id":"54ca1ff6f4c2b70d008597a2","default":"1","desc":"The radius of the circular area of this zone, in meters. [200m, 2000km]","name":"radius","required":false,"type":"double"},{"name":"lat","required":false,"type":"double","in":"body","_id":"54ca1ff6f4c2b70d008597a1","default":"0","desc":"latitude"},{"in":"body","_id":"54ca1ff6f4c2b70d008597a0","default":"0","desc":"longitude","name":"lng","required":false,"type":"double"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"name\":\"Sample Zone 1\",\n  \"radius\":201,\n  \"lat\":42.456,\n  \"lng\":2.478\n}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/v:version/zones"},"editedParams2":true,"hidden":false,"title":"Create Zone","type":"post","body":"","githubsync":"","slug":"zones-create","sync_unique":"","__v":2,"childrenPages":[]}

postCreate Zone

Create a zone

Body Params

name:
required
string
A human readable name for the zone, e.g. "Mountain View Office"
radius:
double1
The radius of the circular area of this zone, in meters. [200m, 2000km]
lat:
double0
latitude
lng:
double0
longitude

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"54c8ef9c0174630d00efa859","updates":[],"user":"545383ac08d1800800473d8d","__v":0,"category":"54d3680f87ea950d00f1bcbb","project":"545386120c09721000a069f5","slug":"zones-partial-update","type":"patch","sync_unique":"","api":{"auth":"required","method":"patch","params":[{"type":"int","in":"path","_id":"54c8ef734574700d00f01638","default":"","desc":"Zone ID","name":"id","required":true}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"lng\":3.1415\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/zones/:id"},"createdAt":"2015-01-28T14:18:04.965Z","editedParams":true,"editedParams2":true,"githubsync":"","body":"","order":3,"title":"Partial Update Zone","version":"54c8b329b3334c0d00236654","excerpt":"","hidden":false,"link_external":false,"link_url":"","childrenPages":[]}

patchPartial Update Zone


Path Params

id:
required
integer
Zone ID

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"54c8ef734574700d00f01637","order":4,"hidden":false,"link_external":false,"link_url":"","sync_unique":"","title":"Update Zone","createdAt":"2015-01-28T14:17:23.617Z","excerpt":"Update a Zone","project":"545386120c09721000a069f5","editedParams":true,"githubsync":"","updates":[],"user":"545383ac08d1800800473d8d","api":{"auth":"required","method":"put","params":[{"desc":"Zone ID","name":"id","required":true,"type":"int","in":"path","_id":"54c8ef734574700d00f01638","default":""}],"results":{"codes":[{"language":"json","code":"{\n  \"name\":\"Sample Zone 1\",\n  \"radius\":12,\n  \"lat\":42.456,\n  \"lng\":2.478\n}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/zones/:id"},"body":"","category":"54d3680f87ea950d00f1bcbb","slug":"zones-update","type":"put","version":"54c8b329b3334c0d00236654","__v":0,"editedParams2":true,"childrenPages":[]}

putUpdate Zone

Update a Zone

Path Params

id:
required
integer
Zone ID

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"_id":"54c8efbb7a11f60d0022a820","editedParams2":true,"excerpt":"Delete a zone","githubsync":"","hidden":false,"link_external":false,"slug":"zones-delete","__v":0,"editedParams":true,"user":"545383ac08d1800800473d8d","title":"Delete Zone","type":"delete","order":5,"project":"545386120c09721000a069f5","category":"54d3680f87ea950d00f1bcbb","createdAt":"2015-01-28T14:18:35.362Z","body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Deleting a zone does not delete points\",\n  \"body\": \"Deleting a Zone will not delete related points. Make sure you don't have orphan points.\"\n}\n[/block]","sync_unique":"","version":"54c8b329b3334c0d00236654","api":{"url":"/:version/zones/:id","auth":"required","method":"delete","params":[{"_id":"54c8ef734574700d00f01638","required":false,"desc":"Zone ID","default":"","type":"int","name":"id","in":"path"}],"results":{"codes":[{"status":204,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"link_url":"","updates":[],"childrenPages":[]}

deleteDelete Zone

Delete a zone

Path Params

id:
integer
Zone ID
[block:callout] { "type": "danger", "title": "Deleting a zone does not delete points", "body": "Deleting a Zone will not delete related points. Make sure you don't have orphan points." } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:callout] { "type": "danger", "title": "Deleting a zone does not delete points", "body": "Deleting a Zone will not delete related points. Make sure you don't have orphan points." } [/block]
{"_id":"555f05c757fe0a0d00c8f3d8","project":"545386120c09721000a069f5","title":"Get All Zone Visits","type":"get","category":"54d3680f87ea950d00f1bcbb","editedParams2":true,"editedParams":true,"excerpt":"","link_external":false,"order":6,"version":"54c8b329b3334c0d00236654","__v":4,"api":{"auth":"required","examples":{"codes":[{"language":"text","code":"","name":""}]},"method":"get","params":[{"required":true,"desc":"zone id","default":"","type":"int","name":"id","in":"path","_id":"555f4a2557fe0a0d00c8f48d"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"count\": 1,\n  \"next\": null,\n  \"previous\": null,\n  \"results\": [\n    {\n      \"entered_at\": \"2015-06-22T16:11:25Z\",\n      \"left_at\": \"2015-06-22T16:11:37Z\",\n      \"id\": 697,\n      \"user\": 5060,\n      \"entered_lat\": 40.3971135,\n      \"entered_lng\": 3.1720145,\n      \"entered_accuracy\": 30,\n      \"left_lat\": 40.4971135,\n      \"left_lng\": 3.2720145,\n      \"left_accuracy\": 1\n    }\n  ]\n}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/v:version/zone/:id/visits"},"githubsync":"","link_url":"","sync_unique":"","updates":[],"user":"545383ac08d1800800473d8d","body":"Returns paginated results for all visits, sorted by `entered_at` desc. `next` and `previous` are absolute URLs that point to the next and previous pages.\nEvery device has a user in the system. Find out who is this user with [this](http://movintracks.readme.io/v2.0/docs/devices-get-all) http://movintracks.readme.io/v2.0/docs/devices-get-all\n\nFilters:\n* user\n\nOrdering:\n* entered_at\n* left_at\n\nExample: filter by `user` and order desc by `entered_at`\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http https://api.movintracks.io/v2.0/zones/1/visits?user=2&ordering=-entered_at\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nOrder asc by `entered_at` and desc by `left_at`\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http https://api.movintracks.io/v2.0/zones/1/visits?ordering=entered_at,-left_at\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","slug":"zone-visits-get-all","createdAt":"2015-05-22T10:32:39.394Z","hidden":false,"childrenPages":[]}

getGet All Zone Visits


Path Params

id:
required
integer
zone id
Returns paginated results for all visits, sorted by `entered_at` desc. `next` and `previous` are absolute URLs that point to the next and previous pages. Every device has a user in the system. Find out who is this user with [this](http://movintracks.readme.io/v2.0/docs/devices-get-all) http://movintracks.readme.io/v2.0/docs/devices-get-all Filters: * user Ordering: * entered_at * left_at Example: filter by `user` and order desc by `entered_at` [block:code] { "codes": [ { "code": "http https://api.movintracks.io/v2.0/zones/1/visits?user=2&ordering=-entered_at", "language": "shell" } ] } [/block] Order asc by `entered_at` and desc by `left_at` [block:code] { "codes": [ { "code": "http https://api.movintracks.io/v2.0/zones/1/visits?ordering=entered_at,-left_at", "language": "shell" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Returns paginated results for all visits, sorted by `entered_at` desc. `next` and `previous` are absolute URLs that point to the next and previous pages. Every device has a user in the system. Find out who is this user with [this](http://movintracks.readme.io/v2.0/docs/devices-get-all) http://movintracks.readme.io/v2.0/docs/devices-get-all Filters: * user Ordering: * entered_at * left_at Example: filter by `user` and order desc by `entered_at` [block:code] { "codes": [ { "code": "http https://api.movintracks.io/v2.0/zones/1/visits?user=2&ordering=-entered_at", "language": "shell" } ] } [/block] Order asc by `entered_at` and desc by `left_at` [block:code] { "codes": [ { "code": "http https://api.movintracks.io/v2.0/zones/1/visits?ordering=entered_at,-left_at", "language": "shell" } ] } [/block]
{"_id":"554268106592e60d00027cc7","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 9,\n    \"short_url\": \"https://api.movintracks.io/v2.0/short/NJ\"\n  }\n]","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/:version/nfc-tags"},"body":"You can use NFC Tags with Movintracks. Create one and write the url given to your tag.\nThen change the related campaign as many times as you wish.","hidden":false,"link_external":false,"type":"get","githubsync":"","project":"545386120c09721000a069f5","slug":"get-all-nfc-tags","title":"Get All NFC Tags","updates":[],"__v":1,"category":"5517d23a82f73b0d004026aa","createdAt":"2015-04-30T17:36:16.185Z","link_url":"","order":0,"excerpt":"Gets all NFC Tags","sync_unique":"","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","childrenPages":[]}

getGet All NFC Tags

Gets all NFC Tags

You can use NFC Tags with Movintracks. Create one and write the url given to your tag. Then change the related campaign as many times as you wish.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



You can use NFC Tags with Movintracks. Create one and write the url given to your tag. Then change the related campaign as many times as you wish.
{"_id":"554268766592e60d00027cca","githubsync":"","title":"Create NFC Tags","updates":[],"type":"post","__v":0,"createdAt":"2015-04-30T17:37:58.136Z","editedParams":true,"excerpt":"Gets all NFC Tags","hidden":false,"link_external":false,"sync_unique":"","version":"54c8b329b3334c0d00236654","api":{"method":"post","params":[{"name":"campaign","in":"body","_id":"554268766592e60d00027ccb","required":true,"desc":"campaign id","default":"","type":"int"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"campaign\": 1,\n    \"id\": 9,\n    \"short_url\": \"https://api.movintracks.io/v2.0/short/NJ\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/:version/nfc-tags","auth":"required"},"body":"You can use NFC Tags with Movintracks. Create one and write the url given to your tag.\nThen change the related campaign as many times as you wish.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"short_url is read only\",\n  \"body\": \"The short_url field is read only.\"\n}\n[/block]","editedParams2":true,"link_url":"","slug":"create-nfc-tags","category":"5517d23a82f73b0d004026aa","order":1,"project":"545386120c09721000a069f5","user":"545383ac08d1800800473d8d","childrenPages":[]}

postCreate NFC Tags

Gets all NFC Tags

Body Params

campaign:
required
integer
campaign id
You can use NFC Tags with Movintracks. Create one and write the url given to your tag. Then change the related campaign as many times as you wish. [block:callout] { "type": "info", "title": "short_url is read only", "body": "The short_url field is read only." } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



You can use NFC Tags with Movintracks. Create one and write the url given to your tag. Then change the related campaign as many times as you wish. [block:callout] { "type": "info", "title": "short_url is read only", "body": "The short_url field is read only." } [/block]
{"_id":"55255076bdcaeb35006698d3","order":0,"title":"Get All SDKs","updates":[],"version":"54c8b329b3334c0d00236654","category":"5517d24c07dedf0d00a3f5ab","body":"Gets the SDKs available for download. There are filters available:\n* latest=[True, False]\n* platform=[ios, android, cordova]\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"Filter parameter *values* (e.g. True, False, ios) are case sensistive.\",\n  \"title\": \"Case sensitive!\"\n}\n[/block]\nYou can also order the elements by any of these fields:\n* id\n* platform\n* version_major\n* version_minor\n* version_patch\n\nFor example, with httpie:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http https://api.movintracks.io/v2.0/sdks?order=-version_major,-version_minor,-version_patch \\\"Authorization: Bearer ...\\\"\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nYou can get only the latest version for all platforms with **?latest=True** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ http https://api.movintracks.io/v2.0/sdks?latest=True\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]","excerpt":"Gets all SDKs","link_url":"","type":"get","__v":4,"hidden":false,"link_external":false,"project":"545386120c09721000a069f5","slug":"sdks-get-all","createdAt":"2015-04-08T15:59:50.895Z","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"code":"[\n  {\n    \"download_url\": \"https://api.movintracks.io/download-sdk/1\",\n    \"id\": 1,\n    \"latest\": false,\n    \"platform\": \"ios\",\n    \"version\": \"1.4.0\"\n  }\n]","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"/v:version/sdks"},"githubsync":"","sync_unique":"","user":"545383ac08d1800800473d8d","childrenPages":[]}

getGet All SDKs

Gets all SDKs

Gets the SDKs available for download. There are filters available: * latest=[True, False] * platform=[ios, android, cordova] [block:callout] { "type": "danger", "body": "Filter parameter *values* (e.g. True, False, ios) are case sensistive.", "title": "Case sensitive!" } [/block] You can also order the elements by any of these fields: * id * platform * version_major * version_minor * version_patch For example, with httpie: [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/sdks?order=-version_major,-version_minor,-version_patch \"Authorization: Bearer ...\"", "language": "text" } ] } [/block] You can get only the latest version for all platforms with **?latest=True** [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/sdks?latest=True", "language": "text" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Gets the SDKs available for download. There are filters available: * latest=[True, False] * platform=[ios, android, cordova] [block:callout] { "type": "danger", "body": "Filter parameter *values* (e.g. True, False, ios) are case sensistive.", "title": "Case sensitive!" } [/block] You can also order the elements by any of these fields: * id * platform * version_major * version_minor * version_patch For example, with httpie: [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/sdks?order=-version_major,-version_minor,-version_patch \"Authorization: Bearer ...\"", "language": "text" } ] } [/block] You can get only the latest version for all platforms with **?latest=True** [block:code] { "codes": [ { "code": "$ http https://api.movintracks.io/v2.0/sdks?latest=True", "language": "text" } ] } [/block]
{"_id":"5524e6ced553bc17008d8ab5","hidden":false,"link_external":false,"link_url":"","order":0,"project":"545386120c09721000a069f5","sync_unique":"","__v":0,"excerpt":"Gets usage information about campaigns","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","type":"get","updates":[],"body":"Returns basic statistics about campaigns. For each campaign, the number of deliveries.","createdAt":"2015-04-08T08:29:02.454Z","api":{"method":"get","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"[\n    {\n        \"campaign\": 1,\n        \"deliveries_count\": 99\n    }\n]"},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/campaign-stats","auth":"required"},"slug":"campaign-stats-get-all","title":"Get All Stats Campaign","category":"5517da1d15f7bd170082e4c5","githubsync":"","childrenPages":[]}

getGet All Stats Campaign

Gets usage information about campaigns

Returns basic statistics about campaigns. For each campaign, the number of deliveries.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Returns basic statistics about campaigns. For each campaign, the number of deliveries.
{"_id":"5524ec8dbdcaeb3500669834","api":{"url":"/v:version/point-stats","auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"avg_duration\": 12,\n    \"point_id\": 1,\n    \"visits_count\": 953\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"excerpt":"Gets usage information about points","hidden":false,"link_external":false,"__v":1,"project":"545386120c09721000a069f5","sync_unique":"","title":"Get All Point Stats","type":"get","category":"5517da1d15f7bd170082e4c5","createdAt":"2015-04-08T08:53:33.702Z","githubsync":"","link_url":"","updates":[],"user":"545383ac08d1800800473d8d","body":"Returns basic statistics about points. For each point, the average duration of visits in seconds and the total number of visits.","order":1,"slug":"point-stats-get-all","version":"54c8b329b3334c0d00236654","childrenPages":[]}

getGet All Point Stats

Gets usage information about points

Returns basic statistics about points. For each point, the average duration of visits in seconds and the total number of visits.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Returns basic statistics about points. For each point, the average duration of visits in seconds and the total number of visits.
{"_id":"55b64880c2e909190073ec3a","__v":0,"api":{"params":[],"results":{"codes":[{"language":"json","code":"[\n  {\n    \"visits_count\": 8,\n    \"avg_duration\": 117,\n    \"zone_id\": 187056\n  }\n]","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/v:version/zone-stats","auth":"required","method":"get"},"githubsync":"","project":"545386120c09721000a069f5","slug":"get-all-zone-stats","updates":[],"excerpt":"Gets usage information about zones","hidden":false,"title":"Get All Zone Stats","version":"54c8b329b3334c0d00236654","body":"Returns basic statistics about points. For each point, the average duration of visits in seconds and the total number of visits.","category":"5517da1d15f7bd170082e4c5","link_external":false,"link_url":"","order":2,"sync_unique":"","user":"545383ac08d1800800473d8d","createdAt":"2015-07-27T15:04:32.875Z","type":"get","childrenPages":[]}

getGet All Zone Stats

Gets usage information about zones

Returns basic statistics about points. For each point, the average duration of visits in seconds and the total number of visits.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Returns basic statistics about points. For each point, the average duration of visits in seconds and the total number of visits.
{"_id":"5524eceae9e34e3700e8d90a","order":3,"sync_unique":"","type":"get","updates":[],"user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"visits_point_count\": 1,\n    \"avg_duration_point\": \"14.0\",\n    \"visits_zone_count\": 0,\n    \"visits_count\": 1,\n    \"avg_duration\": \"14.0\",\n    \"avg_duration_zone\": 0,\n    \"date\": \"2014-11-21\"\n]","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"/v:version/time-stats"},"body":"Returns basic statistics about visits per day. For each day, the average duration of visits in seconds and the total number of visits (per point and zone)","excerpt":"Gets usage information about campaigns","category":"5517da1d15f7bd170082e4c5","createdAt":"2015-04-08T08:55:06.399Z","githubsync":"","hidden":false,"link_external":false,"project":"545386120c09721000a069f5","__v":1,"link_url":"","slug":"time-stats-get-all","title":"Get All Time Stats","childrenPages":[]}

getGet All Time Stats

Gets usage information about campaigns

Returns basic statistics about visits per day. For each day, the average duration of visits in seconds and the total number of visits (per point and zone)

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Returns basic statistics about visits per day. For each day, the average duration of visits in seconds and the total number of visits (per point and zone)
{"_id":"5524edd3bdcaeb3500669839","version":"54c8b329b3334c0d00236654","category":"5517da1d15f7bd170082e4c5","excerpt":"Gets usage information about campaigns","project":"545386120c09721000a069f5","sync_unique":"","__v":2,"body":"Returns basic statistics about coupons. For each coupon, the count of valid and invalid uses, and the name of the coupon, for the sake of simplicity.","user":"545383ac08d1800800473d8d","link_url":"","type":"get","createdAt":"2015-04-08T08:58:59.750Z","githubsync":"","hidden":false,"link_external":false,"order":4,"slug":"coupon-stats-get-all","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"language":"json","code":"[\n  {\n    \"valid\":3,\n    \"expired\":1,\n    \"name\":\"a sample coupon\",\n    \"invalid\":1,\n    \"coupon_id\":1\n  }\n]","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/v:version/coupon-stats"},"title":"Get All Coupon Stats","updates":[],"childrenPages":[]}

getGet All Coupon Stats

Gets usage information about campaigns

Returns basic statistics about coupons. For each coupon, the count of valid and invalid uses, and the name of the coupon, for the sake of simplicity.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Returns basic statistics about coupons. For each coupon, the count of valid and invalid uses, and the name of the coupon, for the sake of simplicity.
{"_id":"5524f2e3bdcaeb3500669846","category":"5517da1d15f7bd170082e4c5","hidden":false,"link_url":"","order":5,"__v":0,"slug":"survey-stats-get-all","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","link_external":false,"body":"Returns basic statistics about surveys. For each survey, the count of submissions.","createdAt":"2015-04-08T09:20:35.813Z","project":"545386120c09721000a069f5","title":"Get All Survey Stats","type":"get","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"code":"[\n  {\n    \"action_survey__survey\": 1,\n    \"action_survey__survey__title\": \"Example\",\n    \"submissions_count\": 22\n  }\n]","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/v:version/survey-stats"},"excerpt":"Gets usage information about campaigns","githubsync":"","sync_unique":"","updates":[],"childrenPages":[]}

getGet All Survey Stats

Gets usage information about campaigns

Returns basic statistics about surveys. For each survey, the count of submissions.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Returns basic statistics about surveys. For each survey, the count of submissions.
{"_id":"5524f5202dc8d12f00143a01","excerpt":"Gets usage information about campaigns","githubsync":"","link_external":false,"body":"Returns statistics for a given survey. For each answer, the count of submissions.\nYou can combine it with the surveys endpoint to discover the text of the answer.\nFor example, if you get the survey with the correct id:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"answers\\\": [\\n        \\\"Answer with index 0, Batman\\\",\\n        \\\"Answer with index 1, Darth Vader\\\"\\n    ],\\n    \\\"id\\\": 1,\\n    \\\"img_url\\\": \\\"...\\\",\\n    \\\"question\\\": \\\"What's your favourite non-fictional character?\\\",\\n    \\\"title\\\": \\\"Likes and dislikes\\\",\\n    \\\"webview\\\": \\\"https://api.movintracks.io/v2.0/webviews/surveys/1\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","category":"5517da1d15f7bd170082e4c5","sync_unique":"","__v":0,"editedParams2":true,"hidden":false,"link_url":"","slug":"get-one-survey-stats","user":"545383ac08d1800800473d8d","version":"54c8b329b3334c0d00236654","api":{"auth":"required","method":"get","params":[{"_id":"5524f5202dc8d12f00143a02","required":true,"desc":"survey id","default":"","type":"string","name":"id","in":"path"}],"results":{"codes":[{"language":"json","code":"[\n  {\n    \"answer\": 0,\n    \"count\": 9\n  },\n  {\n    \"answer\": 1,\n    \"count\": 13\n  }\n]","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/v:version/survey-stats/:id"},"order":6,"project":"545386120c09721000a069f5","title":"Get One Survey Stats","type":"get","updates":[],"createdAt":"2015-04-08T09:30:08.776Z","editedParams":true,"childrenPages":[]}

getGet One Survey Stats

Gets usage information about campaigns

Path Params

id:
required
string
survey id
Returns statistics for a given survey. For each answer, the count of submissions. You can combine it with the surveys endpoint to discover the text of the answer. For example, if you get the survey with the correct id: [block:code] { "codes": [ { "code": "{\n \"answers\": [\n \"Answer with index 0, Batman\",\n \"Answer with index 1, Darth Vader\"\n ],\n \"id\": 1,\n \"img_url\": \"...\",\n \"question\": \"What's your favourite non-fictional character?\",\n \"title\": \"Likes and dislikes\",\n \"webview\": \"https://api.movintracks.io/v2.0/webviews/surveys/1\"\n}", "language": "json" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Returns statistics for a given survey. For each answer, the count of submissions. You can combine it with the surveys endpoint to discover the text of the answer. For example, if you get the survey with the correct id: [block:code] { "codes": [ { "code": "{\n \"answers\": [\n \"Answer with index 0, Batman\",\n \"Answer with index 1, Darth Vader\"\n ],\n \"id\": 1,\n \"img_url\": \"...\",\n \"question\": \"What's your favourite non-fictional character?\",\n \"title\": \"Likes and dislikes\",\n \"webview\": \"https://api.movintracks.io/v2.0/webviews/surveys/1\"\n}", "language": "json" } ] } [/block]
{"_id":"555c409a87ebf70d002adc2d","category":"5517da1d15f7bd170082e4c5","excerpt":"","sync_unique":"","user":"545383ac08d1800800473d8d","__v":3,"body":"Campaign deliveries, paginated. It accepts filters and ordering\n\nFilters:\n* **campaign**: campaign id\n* **min_delivered_at**:  date and time in format YYYY-MM-DD hh:mm:ss\n* **max_delivered_at**: date and time in format YYYY-MM-DD hh:mm:ss\n* **delivered_at**: date in format YYYY-MM-DD\n\nOrdering:\nResults can be ordered by **delivered_at**, **id** \n\nDefault page size is 10.","updates":[],"version":"54c8b329b3334c0d00236654","githubsync":"","link_external":false,"title":"Get All Campaign Deliveries","link_url":"","slug":"campaign-deliveries-get-all","order":7,"project":"545386120c09721000a069f5","type":"get","api":{"settings":"","url":"/v:version/campaign-deliveries","auth":"required","examples":{"codes":[{"name":"","language":"shell","code":"$ http https://api.movintracks.io/v2.0/campaign-deliveries?min_delivered_at=\"2014-10-01 08:20:00\"&max_delivered_at=\"2014-10-01 23:59:59\"&ordering=delivered_at  \"Authorization: Bearer $MT_TOKEN\"\n\n$ http https://api.movintracks.io/v2.0/campaign-deliveries?delivered_at=2014-10-01 \"Authorization: Bearer $MT_TOKEN\"\n\n$ http https://api.movintracks.io/v2.0/campaign-deliveries?campaign=123 \"Authorization: Bearer $MT_TOKEN\"\n\n$ http https://api.movintracks.io/v2.0/campaign-deliveries?device=123 \"Authorization: Bearer $MT_TOKEN\"\n"}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"count\": 115,\n  \"next\": \"http://api.movintracks.io/v2.0/campaign-deliveries?page=2\",\n  \"previous\": null,\n  \"results\": [\n    {\n      \"campaign\": 1,\n      \"delivered_at\": \"2015-04-09T08:06:55Z\",\n      \"device\": 1,\n      \"id\": 1\n    },\n    ...\n  ]\n}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]}},"createdAt":"2015-05-20T08:06:50.927Z","hidden":false,"childrenPages":[]}

getGet All Campaign Deliveries


Campaign deliveries, paginated. It accepts filters and ordering Filters: * **campaign**: campaign id * **min_delivered_at**: date and time in format YYYY-MM-DD hh:mm:ss * **max_delivered_at**: date and time in format YYYY-MM-DD hh:mm:ss * **delivered_at**: date in format YYYY-MM-DD Ordering: Results can be ordered by **delivered_at**, **id** Default page size is 10.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Campaign deliveries, paginated. It accepts filters and ordering Filters: * **campaign**: campaign id * **min_delivered_at**: date and time in format YYYY-MM-DD hh:mm:ss * **max_delivered_at**: date and time in format YYYY-MM-DD hh:mm:ss * **delivered_at**: date in format YYYY-MM-DD Ordering: Results can be ordered by **delivered_at**, **id** Default page size is 10.