Engagement.ManagementClient
Microsoft Azure Mobile Engagement REST APIs.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Microsoft Azure Mobile Engagement REST APIs.
Endpoints 37
AppCollections
- GETAppCollections_List
/subscriptions/:subscriptionId/providers/Microsoft.MobileEngagement/appCollections?api-version=stringLists app collections in a subscription.
List
- GETSupportedPlatforms_List
/subscriptions/:subscriptionId/providers/Microsoft.MobileEngagement/supportedPlatforms?api-version=stringLists supported platforms for Engagement applications.
Apps
- GETApps_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps?api-version=stringLists apps in an appCollection.
Campaign
- GETCampaigns_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaigns/:kind?api-version=string&$skip=0&$top=0&$filter=string&$orderby=string&$search=stringGet the list of campaigns. - POSTCampaigns_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaigns/:kind?api-version=stringCreate a push campaign (announcement, poll, data push or native push). - POSTCampaigns_TestNew
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaigns/:kind/test?api-version=stringTest a new campaign on a set of devices. - GETCampaigns_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaigns/:kind/:id?api-version=stringThe Get campaign operation retrieves information about a previously created campaign. - PUTCampaigns_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaigns/:kind/:id?api-version=stringUpdate an existing push campaign (announcement, poll, data push or native push). - DELETECampaigns_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaigns/:kind/:id?api-version=stringDelete a campaign previously created by a call to Create campaign. - POSTCampaigns_Activate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaigns/:kind/:id/activate?api-version=stringActivate a campaign previously created by a call to Create campaign. - POSTCampaigns_Finish
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaigns/:kind/:id/finish?api-version=stringFinish a push campaign previously activated by a call to Activate campaign. - POSTCampaigns_Push
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaigns/:kind/:id/push?api-version=stringPush a previously saved campaign (created with Create campaign) to a set of devices. - GETCampaigns_GetStatistics
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaigns/:kind/:id/statistics?api-version=stringGet all the campaign statistics. - POSTCampaigns_Suspend
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaigns/:kind/:id/suspend?api-version=stringSuspend a push campaign previously activated by a call to Activate campaign. - POSTCampaigns_TestSaved
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaigns/:kind/:id/test?api-version=stringTest an existing campaign (created with Create campaign) on a set of devices. - GETCampaigns_GetByName
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/campaignsByName/:kind/:name?api-version=stringThe Get campaign operation retrieves information about a previously created campaign.
Device
- GETDevices_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices?api-version=string&$top=0&$select=string&$filter=stringQuery the information associated to the devices running an application. - POSTDevices_TagByDeviceId
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/tag?api-version=stringUpdate the tags registered for a set of devices running an application. Updates are performed asynchronously, meaning that a few seconds are needed before the… - GETDevices_GetByDeviceId
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/:deviceId?api-version=stringGet the information associated to a device running an application. - POSTDevices_TagByUserId
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/users/tag?api-version=stringUpdate the tags registered for a set of users running an application. Updates are performed asynchronously, meaning that a few seconds are needed before the… - GETDevices_GetByUserId
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/users/:userId?api-version=stringGet the information associated to a device running an application using the user identifier.
export
- GETExportTasks_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/exportTasks?api-version=string&$skip=0&$top=20&$orderby=stringGet the list of export tasks. - POSTExportTasks_CreateActivitiesTask
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/exportTasks/activities?api-version=stringCreates a task to export activities. - POSTExportTasks_CreateCrashesTask
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/exportTasks/crashes?api-version=stringCreates a task to export crashes. - POSTExportTasks_CreateErrorsTask
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/exportTasks/errors?api-version=stringCreates a task to export errors. - POSTExportTasks_CreateEventsTask
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/exportTasks/events?api-version=stringCreates a task to export events. - POSTExportTasks_CreateFeedbackTaskByCampaign
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/exportTasks/feedbackByCampaign?api-version=stringCreates a task to export push campaign data for a set of campaigns. - POSTExportTasks_CreateFeedbackTaskByDateRange
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/exportTasks/feedbackByDate?api-version=stringCreates a task to export push campaign data for a date range. - POSTExportTasks_CreateJobsTask
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/exportTasks/jobs?api-version=stringCreates a task to export jobs. - POSTExportTasks_CreateSessionsTask
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/exportTasks/sessions?api-version=stringCreates a task to export sessions. - POSTExportTasks_CreateTagsTask
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/exportTasks/tags?api-version=stringCreates a task to export tags. - POSTExportTasks_CreateTokensTask
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/exportTasks/tokens?api-version=stringCreates a task to export tags. - GETExportTasks_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/exportTasks/:id?api-version=stringRetrieves information about a previously created export task.
import
- GETImportTasks_List
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/importTasks?api-version=string&$skip=0&$top=20&$orderby=stringGet the list of import jobs. - POSTImportTasks_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/importTasks?api-version=stringCreates a job to import the specified data to a storageUrl. - GETImportTasks_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.MobileEngagement/appcollections/:appCollection/apps/:appName/devices/importTasks/:id?api-version=stringThe Get import job operation retrieves information about a previously created import job.
- POSTAppCollections_CheckNameAvailability
/subscriptions/:subscriptionId/providers/Microsoft.MobileEngagement/checkAppCollectionNameAvailability?api-version=stringChecks availability of an app collection name in the Engagement domain.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 37 operations on 33 pathsPOST 21GET 14PUT 1DELETE 1
- Main resources
- Campaign 13crud 13export 12CRUD 5Device 5Action 4List 4import 3Test 2list 2
- Response formats
application/json- Description format
- Swagger 2.0, API version
2014-12-01 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Engagement.ManagementClient in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Engagement.ManagementClient collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “AppCollections_List” (GET /subscriptions/:subscriptionId/providers/Microsoft.MobileEngagement/appCollections?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Engagement.ManagementClient?
Microsoft Azure Mobile Engagement REST APIs. It is listed under Developer tools and has 37 endpoints.
Who publishes the Engagement.ManagementClient?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Engagement.ManagementClient?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Engagement.ManagementClient?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Engagement.ManagementClient have?
37 operations on 33 paths (21 POST, 14 GET, 1 PUT, 1 DELETE). The largest groups are Campaign, crud, export, CRUD.
Is forking the Engagement.ManagementClient free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.