API ConsoleAPI Documentation
  • Toggle All Resources
  • Toggle All Methods

  • Users
    • List Methods
    • Expand Methods

    • GETGet Current User Profile/users/self
      Get the current user's profile

      Description
      Location
      Type
      Value
      Parameter
    • GETGet User Devices/users/{userId}/devices
      Get a user's devices

      Description
      Location
      Type
      Value
      Parameter
    • GETGet User Device Types/users/{userId}/devicetypes
      Get a user's device types

      Description
      Location
      Type
      Value
      Parameter
    • GETGet User Application Properties/users/{userId}/properties
      Get a user's application properties

      Description
      Location
      Type
      Value
      Parameter
    • POSTCreate User Application Properties/users/{userId}/properties
      Create a user's application properties

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDelete User Application Properties/users/{userId}/properties
      Delete a user's application properties

      Description
      Location
      Type
      Value
      Parameter
    • PUTUpdate User Application Properties/users/{userId}/properties
      Update a user's application properties

      Description
      Location
      Type
      Value
      Parameter
    • GETGet User Rules/users/{userId}/rules
      Get a user's rules

      Description
      Location
      Type
      Value
      Parameter
    • GETGet User Trials/users/{userId}/trials
      Get a user's trials

      Description
      Location
      Type
      Value
      Parameter

  • Tokens
    • List Methods
    • Expand Methods

    • GETToken Info/accounts/tokenInfo
      Get the token information

      Description
      Location
      Type
      Value
      Parameter

  • Devices
    • List Methods
    • Expand Methods

    • GETGet Device/devices/{deviceId}
      Get a device

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Device Token/devices/{deviceId}/tokens
      Get a device's token

      Description
      Location
      Type
      Value
      Parameter
    • POSTAdd Device/devices
      Create a device

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDelete Device/devices/{deviceId}
      Delete a device

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDelete Device Token/devices/{deviceId}/tokens
      Delete a device's token

      Description
      Location
      Type
      Value
      Parameter
    • PUTUpdate Device/devices/{deviceId}
      Update a device

      Description
      Location
      Type
      Value
      Parameter
    • PUTUpdate Device Token/devices/{deviceId}/tokens
      Update a device's token

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Device Presence Information/devices/{deviceId}/presence
      Return the presence status of the device along with the time it was last seen

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Device Status/devices/{deviceId}/status
      Get Device Status

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Devices Status/devices/status
      Get Devices Status

      Description
      Location
      Type
      Value
      Parameter
    • PUTUpdate Device Status/devices/{deviceId}/status
      Update Device Status

      Description
      Location
      Type
      Value
      Parameter
    • POSTShare a device /devices/{deviceId}/shares
      Share a device

      Description
      Location
      Type
      Value
      Parameter
    • GETGet specific share of the given device id/devices/{deviceId}/shares/{shareId}
      Get specific share of the given device id

      Description
      Location
      Type
      Value
      Parameter
    • GETList all shares for the given device id/devices/{deviceId}/shares
      List all shares for the given device id

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDelete specific share of the given device id/devices/{deviceId}/shares/{shareId}
      Delete specific share of the given device id

      Description
      Location
      Type
      Value
      Parameter

  • Registrations
    • List Methods
    • Expand Methods

    • PUTConfirm User/devices/registrations/pin
      This call updates the registration request issued earlier by associating it with an authenticated user and captures all additional information required to add a new device.

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Request Status For User/devices/registrations/{requestId}/status
      This call checks the status of the request so users can poll and know when registration is complete.

      Description
      Location
      Type
      Value
      Parameter
    • DELETEUnregister Device/devices/{deviceId}/registrations
      This call clears any associations from the secure device registration.

      Description
      Location
      Type
      Value
      Parameter

  • Device Types
    • List Methods
    • Expand Methods

    • GETGet Device Type/devicetypes/{deviceTypeId}
      Get a device type

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Device Types/devicetypes
      Search for device types by name

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Available Manifest Versions/devicetypes/{deviceTypeId}/availablemanifestversions
      Get a device type's available Manifest versions

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Latest Manifest Properties/devicetypes/{deviceTypeId}/manifests/latest/properties
      Get properties for the latest Manifest version of a device type

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Manifest Properties/devicetypes/{deviceTypeId}/manifests/{version}/properties
      Get properties for a specific Manifest version of a device type

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Device Types by Application/applications/{applicationId}/devicetypes
      Get an Application's device types from the scope parameters

      Description
      Location
      Type
      Value
      Parameter

  • Messages
    • List Methods
    • Expand Methods

    • POSTSend Message/messages
      Send a Message from a Source Device

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Normalized Messages/messages
      Get normalized messages. The following request patterns are supported:
      CombinationParameters
      Get by Device and date rangesdid, endDate, startDate
      Get by Message IDmid
      Get by Device and field presencesdid, fieldPresence
      Get by Device, filter and date rangesdid, filter, startDate, endDate


      Description
      Location
      Type
      Value
      Parameter
    • POSTSend Actions/actions
      Send Actions to a Destination Device

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Normalized Actions/actions
      Get normalized actions. The following request patterns are supported:
      CombinationParameters
      Get by Device and date rangeddid, endDate, startDate
      Get by Message IDmid


      Description
      Location
      Type
      Value
      Parameter
    • GETGet Last Normalized Messages/messages/last
      Get last normalized messages

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Normalized Messages Presence/messages/presence
      Get normalized message presence. Returns bucketed timelines (in milliseconds since epoch) for which there was at least one message received.
      The grouping interval constrains the duration as:

      1. If the interval is minute, you can query up to a maximum of one hour at a time
      2. If the interval is hour, you can query up to a maximum of 24 hours at a time
      3. If the interval is day, you can query up to a maximum of 31 days at a time
      4. If the interval is month, you can query up to a maximum of 12 months at a time
      5. If the interval is year, you can query up to a maximum of 10 years at a time



      Description
      Location
      Type
      Value
      Parameter
    • GETGet Normalized Message Aggregates/messages/analytics/aggregates
      Get aggregates on normalized messages.

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Normalized Message Histogram/messages/analytics/histogram
      Get histogram on normalized messages.

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Message Snapshots/messages/snapshots
      Returns last received value for all Manifest fields (aka device state) of a device type.

      Description
      Location
      Type
      Value
      Parameter

  • Export
    • List Methods
    • Expand Methods

    • POSTCreate Export Request/messages/export
      Export normalized messages. The following input combinations are supported:
      CombinationParametersDescription
      Get by usersuidsSearch by a list of User IDs. For each user in the list, the current authenticated user must have read access over the specified user.
      Get by devicessdidsSearch by Source Device IDs.
      Get by device typesuids,sdtidsSearch by list of Source Device Type IDs for the given list of users.
      Get by trialtrialIdSearch by Trial ID.
      Get by combination of parametersuids,sdids,sdtidsSearch by list of Source Device IDs. Each Device ID must belong to a Source Device Type ID and a User ID.
      CommonstartDate,endDate,order,format,url,csvHeadersParameters that can be used with the above combinations.


      Description
      Location
      Type
      Value
      Parameter
    • GETGet Export History/messages/export/history
      Get the history of export requests.

      Description
      Location
      Type
      Value
      Parameter
    • GETCheck Export Status/messages/export/{exportId}/status
      Check status of the export query.

      Description
      Location
      Type
      Value
      Parameter

  • Notifications (Documentation Only)
    • List Methods
    • Expand Methods

    • POSTCreate Subscription/subscriptions
      Create a new subscription

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDelete Subscription/subscriptions/{subId}
      Delete a subscription

      Description
      Location
      Type
      Value
      Parameter
    • GETGet All Subscriptions/subscriptions
      Get All Subscriptions for an application or application + user

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Subscription/subscriptions/{subId}
      Get a subscription by ID

      Description
      Location
      Type
      Value
      Parameter
    • POSTValidate Subscription/subscriptions/{subId}/validate
      Validate a subscription

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Messages/notifications/{notifId}/messages
      Get messages for a notification.

      Description
      Location
      Type
      Value
      Parameter

  • Rules
    • List Methods
    • Expand Methods

    • POSTCreate Rule/rules
      Create a new Rule

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDelete Rule/rules/{ruleId}
      Delete a Rule

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Rule/rules/{ruleId}
      Get a rule using the Rule ID

      Description
      Location
      Type
      Value
      Parameter
    • PUTUpdate Rule/rules/{ruleId}
      Update an existing Rule

      Description
      Location
      Type
      Value
      Parameter

  • Tags
    • List Methods
    • Expand Methods

    • GETGet all categories/tags/categories
      Get all tags marked as categories

      Description
      Location
      Type
      Value
      Parameter
    • GETGet tag suggestions/tags/suggestions
      Get tag suggestions for applications, device types that have been most used with a group of tags.

      Description
      Location
      Type
      Value
      Parameter
    • GETGet all tags of categories/tags
      Get all tags related to the list of categories

      Description
      Location
      Type
      Value
      Parameter

  • Device Management
    • List Methods
    • Expand Methods

    • GETRead a device's properties./devicemgmt/devices/{did}/properties
      Read a device's properties.

      Description
      Location
      Type
      Value
      Parameter
    • GETQuery device properties across devices./devicemgmt/devices/properties
      Query device properties across devices.

      Description
      Location
      Type
      Value
      Parameter
    • POSTUpdates a device's server properties./devicemgmt/devices/{did}/serverproperties
      Updates a device's server properties.

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDeletes a device's properties./devicemgmt/devices/{did}/serverproperties
      Deletes a device's properties.

      Description
      Location
      Type
      Value
      Parameter
    • PUTUpdates a task for all devices - For now just allows changing the state to cancelled./devicemgmt/tasks/{tid}
      Updates a task for all devices - For now just allows changing the state to cancelled.

      Description
      Location
      Type
      Value
      Parameter
    • GETReturns the details and global status of a specific task id./devicemgmt/tasks/{tid}
      Returns the details and global status of a specific task id.

      Description
      Location
      Type
      Value
      Parameter
    • POSTCreate a new task for one or more devices/devicemgmt/tasks
      Create a new task for one or more devices

      Description
      Location
      Type
      Value
      Parameter
    • GETReturns the details and status of a task id and the individual statuses of each device id in the list./devicemgmt/tasks/{tid}/statuses
      Returns the details and status of a task id and the individual statuses of each device id in the list.

      Description
      Location
      Type
      Value
      Parameter
    • GETReturns the all the tasks for a device type./devicemgmt/tasks
      Returns the all the tasks for a device type.

      Description
      Location
      Type
      Value
      Parameter
    • GETReturns the history of the status changes for a specific task id, or for a specific device id in that task./devicemgmt/tasks/{tid}/statuses/history
      Returns the history of the status changes for a specific task id, or for a specific device id in that task.

      Description
      Location
      Type
      Value
      Parameter
    • PUTUpdates a task for a specific device - For now just allows changing the state to cancelled./devicemgmt/tasks/{tid}/devices/{did}
      Updates a task for a specific device - For now just allows changing the state to cancelled.

      Description
      Location
      Type
      Value
      Parameter
    • GETReturns the list of tasks for a particular device id with optional status filter./devicemgmt/devices/{did}/tasks
      Returns the list of tasks for a particular device id with optional status filter.

      Description
      Location
      Type
      Value
      Parameter
    • GETGet a device type's device management manifest properties/devicemgmt/devicetypes/{dtid}/manifest/properties
      Get a device type's device management manifest properties

      Description
      Location
      Type
      Value
      Parameter
    • GETRead a device type device management information./devicemgmt/devicetypes/{dtid}
      Read a device type device management information.

      Description
      Location
      Type
      Value
      Parameter
    • PUTUpdates a device type information/devicemgmt/devicetypes/{dtid}
      Updates a device type information

      Description
      Location
      Type
      Value
      Parameter

  • Trials
    • List Methods
    • Expand Methods

    • POSTCreate Trial/trials
      Create a new Trial

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDelete Trial/trials/{trialId}
      Deletes an existing trial

      Description
      Location
      Type
      Value
      Parameter
    • GETFind Trial/trials/{trialId}
      Returns a trial with the specified Trial ID.

      Description
      Location
      Type
      Value
      Parameter
    • PUTUpdate Trial/trials/{trialId}
      Updates an existing trial.

      Description
      Location
      Type
      Value
      Parameter
    • PUTUpdate Trial Application/trials/{trialId}/application
      Updates the Trial with a new application

      Description
      Location
      Type
      Value
      Parameter

  • Trials - Devices
    • List Methods
    • Expand Methods

    • POSTAdd Trial Device Type/trials/{trialId}/devicetypes
      Add a DeviceType to Trial

      Description
      Location
      Type
      Value
      Parameter
    • POSTConnect User Device/trials/{trialId}/participants/{userId}/devices
      Add a User Device to a Trial

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDisconnect User Device/trials/{trialId}/participants/{userId}/devices/{deviceId}
      Remove a User Device from a Trial

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Trial Connected Devices/trials/{trialId}/devices
      Get Connected Devices for a Trial

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Trial Device Types/trials/{trialId}/devicetypes
      Find DeviceType for Trial

      Description
      Location
      Type
      Value
      Parameter
    • GETGet User Connected Devices/trials/{trialId}/participants/{userId}/devices
      Get Connected Devices of a User for a Trial

      Description
      Location
      Type
      Value
      Parameter

  • Trials - Members
    • List Methods
    • Expand Methods

    • POSTCreate Trial Invitation/trials/{trialId}/invitations
      Create a new Trial Invitation

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDelete Trial Administrator/trials/{trialId}/administrators/{userId}
      Delete administrator from Trial

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDelete Trial Invitation/trials/{trialId}/invitations/{invitationId}
      Deletes an existing trial invitation

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDelete Trial Participant/trials/{trialId}/participants/{userId}
      Delete participant from Trial

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Trial Administrators/trials/{trialId}/administrators
      Get Administrators for a Trial

      Description
      Location
      Type
      Value
      Parameter
    • GETFind Trial Invitations/trials/{trialId}/invitations
      Returns invitations for a Trial that match a status

      Description
      Location
      Type
      Value
      Parameter
    • GETGet Trial Participants/trials/{trialId}/participants
      Find Participants for Trial

      Description
      Location
      Type
      Value
      Parameter
    • PUTUpdate Trial Invitation/trials/{trialId}/invitations/{invitationId}
      Update an existing Trial Invitation

      Description
      Location
      Type
      Value
      Parameter

  • Machine Learning
    • List Methods
    • Expand Methods

    • GETGet models/ml/models
      Get models

      Description
      Location
      Type
      Value
      Parameter
    • GETGet model/ml/models/{modelId}
      Get model

      Description
      Location
      Type
      Value
      Parameter
    • POSTCreate model/ml/models
      Create model

      Description
      Location
      Type
      Value
      Parameter
    • POSTPredict/ml/models/{modelId}/predict
      Predict

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDelete model/ml/models/{modelId}
      Delete model

      Description
      Location
      Type
      Value
      Parameter

  • Scenes
    • List Methods
    • Expand Methods

    • GETGet scene/scenes/{sceneId}
      Get scene using the Scene ID

      Description
      Location
      Type
      Value
      Parameter
    • GETGet scenes/scenes
      Get all scenes of a user

      Description
      Location
      Type
      Value
      Parameter
    • GETGet a user scenes/users/{uid}/scenes
      Get a user's scenes

      Description
      Location
      Type
      Value
      Parameter
    • PUTUpdate scene/scenes/{sceneId}
      Update a scene

      Description
      Location
      Type
      Value
      Parameter
    • POSTCreate scene/scenes
      Create a scene

      Description
      Location
      Type
      Value
      Parameter
    • DELETEDelete scene/scenes/{sceneId}
      Delete a scene

      Description
      Location
      Type
      Value
      Parameter
    • POSTTrigger scene/scenes/{sceneId}
      Trigger a scene

      Description
      Location
      Type
      Value
      Parameter