Skip to end of metadata
Go to start of metadata


In this section:

Definitions

API Key

The API Key is a unique key assigned to your user account and, through the Medialets Muse REST API, gives you access to any application belonging to any of your teams.

To view your API Key, visit muse.medialets.com and, after logging in, navigate to Your Account > Your Account Info.

For the purposes of this document, a sample API Key of 429a5651921a7f8eaae24f82a18e341cd5c1f553 will be used.

Muse App ID

The Muse App ID is an internal App ID assigned to apps registered on Medialets Muse. The Muse App ID will be used for managing your apps through the REST API.

For the purposes of this document, a sample Muse App ID of 1014039 will be used.

MMAppID

The MMAppID is the ID you embed in your application for deployment.

App Store ID

The App Store ID, also referred to as the Store ID, is the ID of your application as recognized by its respective app store.

Managing Apps

Get a list of registered apps

HTTP method and URL

To retrieve a list apps currently registered in Medialets Muse, enter a URL following the sample below into your web browser.

GET http://www.medialytics.com/client_apps.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553

Example response

<?xml version="1.0" encoding="UTF-8"?>
<client-apps type="array">
  <client-app>
    <appName>My First App</appName>
    <id type="integer">1012619</id>
  </client-app>
  <client-app>
    <appName>My Second App</appName>
    <id type="integer">1012620</id>
  </client-app>
</client-apps>

Get the details of a single app

HTTP method and URL

To retrieve details of a specific app currently registered in Medialets Muse, enter a URL following the sample below into your web browser.

GET http://www.medialytics.com/client_apps/1001820.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553

Example response

<?xml version="1.0" encoding="UTF-8"?>
<client-app>
  <appID>d90d2afd82d9e80069c468b5a158696b52ebfc79</appID>
  <appName>My Second App</appName>
  <cost type="decimal">2.99</cost>
  <developerID type="integer">21565</developerID>
  <id type="integer">1001820</id>
</client-app>
About the IDs Displayed in the Example Response
  • The id tag refers to the Muse App ID. Note that it matches the client_apps value in the URL.
  • The appID tag refers to the MMAppID.

Register a new app

HTTP method and URL

To register a new app with Medialets Muse, enter a URL following the sample below into your web browser.

POST http://www.medialytics.com/client_apps.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553&client_app[appName]=Test

Parameters

  • client_app[appName] - Required
  • client_app[developerID] - Optional. See Managing Teams for more details.

Example response

The response will include details on your new app.

<?xml version="1.0" encoding="UTF-8"?>
<client-app>
  <appID>a19fb32bcda9a50716e71c40c5246e047dd8713f</appID>
  <appName>Test</appName>
  <cost type="decimal" nil="true"></cost>
  <developerID type="integer">21770</developerID>
  <id type="integer">1012618</id>
</client-app>

Modify a registered app

HTTP method and URL

To modify an app currently registered in Medialets Muse, enter a URL following the sample below into your web browser.

Change value of client_app[appName] to "Tested"
PUT http://www.medialytics.com/client_apps/1014039.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553&client_app[appName]=Tested

Example response

You will receive an HTTP OK response header if the update was successful.

Delete a registered app

HTTP method and URL

To delete an app currently registered in Medialets Muse, enter a URL following the sample below into your web browser.

Delete the App with the Muse App ID 1014039
DELETE http://www.medialytics.com/client_apps/1014039.xml

Example response

You will receive an HTTP OK response header if the deletion was successful.

Managing Teams

Get a list of your teams

HTTP method and URL

To retrieve a list of Medialets Muse teams, enter a URL following the sample below into your web browser.

GET http://www.medialytics.com/user_groups.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553

Example response

<?xml version="1.0" encoding="UTF-8"?>
<user-groups type="array">
  <user-group>
    <id type="integer">21565</id>
    <name>Medialets</name>
  </user-group>
  <user-group>
    <id type="integer">21771</id>
    <name>Medialytics</name>
  </user-group>
</user-groups>

Register a new Team

HTTP method and URL

To register a new team in Medialets Muse, enter a URL following the sample below into your web browser.

POST http://www.medialytics.com/user_groups.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553&user_group[name]=Test

Parameters

user_group[name] - Required

Example response

The response will include details on your new Team.

<?xml version="1.0" encoding="UTF-8"?>
<user-group>
  <name>Test</name>
  <id type="integer">11121972</id>
</user-group>

Modify a registered Team

HTTP method and URL

To modify a team currently registered in Medialets Muse, enter a URL following the sample below into your web browser.

Change the value of user_group[name] to "Tested"
PUT http://www.medialytics.com/user_groups/11121972.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553&user_group[name]=Tested

Example response

You will receive an HTTP OK response header if the update was successful.

Specify a team when getting a list of apps

To retrieve a list of apps particular to a team, enter a URL following the sample below into your web browser.

HTTP method and URL

Get a list of apps belonging to team "21771"
GET http://www.medialytics.com/user_groups/21771/client_apps.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553
Note that the URL used to access a list of apps for a given team looks just like URL to retrieve a list of apps with the addition of user_groups/21771 to the beginning of the path.

Example response

The resulting list will look the same as a generic app list but will be filtered by the specified Team.

Specify a team when registering an app

HTTP method and URL

To register an app specific to a desired team, enter a URL following the sample below into your web browser.

POST http://www.medialytics.com/user_groups/21771/client_apps.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553&client_app[appName]=Test
Note that the URL to register a new app to a given team looks just like the generic app registration URL with an addition of the user_groups/21771 to the beginning of the path.

Example response

The response will include details on your new app will look the same as the generic app registration above.

Managing App Versions

Get a list of Versions for a specific app

To retrieve a list of version for a specific app, enter a URL following the sample below into your web browser.

Get a list of version for app with App ID 1014039
GET http://medialytics.com/client_apps/1014039/versions.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553

Example response

<?xml version="1.0" encoding="UTF-8"?>
<client-app-versions type="array">
  <client-app-version>
    <id type="integer">100000220</id>
    <versionKey>2.2</versionKey>
  </client-app-version>
  <client-app-version>
    <id type="integer">100000221</id>
    <versionKey>2.2.1</versionKey>
  </client-app-version>
</client-app-versions>

Get the details for a specific App Version

HTTP method and URL

To retrieve details for a specific App Version, enter a URL following the sample below into your web browser.

Get details for app 1014039, Version 100000221
GET http://medialytics.com/client_apps/1014039/versions/100000221.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553

Example response

<?xml version="1.0" encoding="UTF-8"?>
<client-app-version>
  <app-store-id type="integer">315641765</app-store-id>
  <id type="integer">100000221</id>
  <platform-category-id type="integer">6015</platform-category-id>
  <platform-id type="integer">1</platform-id>
  <versionKey>2.2.1</versionKey>
</client-app-version>

Register a new Version for a specific app

To register a new version for a specific app, enter a URL following the sample below into your web browser.

HTTP method and URL

Register a new version for app 1014039
POST http://www.medialytics.com/client_apps/1014039/versions.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553&client_app_version[versionKey]=1.4&client_app_version[platform_id]=1&client_app_version[releaseDate]=11/12/2008

\\

Parameters

releaseDate - the date the App Version was released
platform_id - the Platform ID for the platform to which the App Version deploys; 1 = iPhone, 2 = Android, 3 = BlackBerry, 4 = Palm, 5 = Windows
app_store_id - the ID of your application as recognized by its respective App Store
platform_category_id - the category of the App Version relative to its respective Platform:


Figure: Sample of Platform Category ID Lists

Example response

The response will include the details on your new app.

<?xml version="1.0" encoding="UTF-8"?>
<client-app-version>
  <app-store-id type="integer" nil="true"></app-store-id>
  <id type="integer">100000228</id>
  <platform-category-id type="integer" nil="true"></platform-category-id>
  <platform-id type="integer">1</platform-id>
  <versionKey>1.4</versionKey>
</client-app-version>

Modify a specific App Version

To modify a specific App Version, enter a URL following the sample below into your web browser.

HTTP method and URL

Modify the version label to "1.5"
PUT http://medialytics.com/client_apps/1014039/versions/100000221.xml?api_key=429a5651921a7f8eaae24f82a18e341cd5c1f553&client_app_version[versionKey]=1.5

Example response

You will receive an HTTP OK response header if the update was successful.

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.