lesson_1

Lesson 1 – Getting Real-time Reports via the Analytics API

Objectives

• Access the Real-time report in Analytics
• Create a Real-time Report request

Viewing the Data in Adobe Analytics

1. Open your web browser and go to my.omniture.com
2. Get username and password from https://marketing.adobe.com/developer/summitlab
3. Login with the following credentials * Company: Real Time Dashboard Lab * User: [use username from step 2] * Password: [use password from step 2]
4. Click on View All Reports > Metrics > Real-time

Take a look around. Everything you see, and a little more, can be pulled via an API.

Pulling a Real-time Report with the API

We are going to use the API explorer to pull a Real-time report with the API. This will let us see how the API works so we can build a dashboard around it.

NOTE: We've provided a set of test credentials for the purposes of this lab. To obtain credentials for your own account, follow the tutorial here.

1. In your browser go to https://marketing.adobe.com/developer/api-explorer

2. Switch to the tab that is showing the https://marketing.adobe.com/developer/summitlab page.

3. Enter the following credentials into the API explorer:

   • Username: [use API login username from step 2]
   • Secret: [use API login secret from step 2]

   NOTE: these credentials are different from the credentials used to login to Adobe Analytics

4. Select the following options

   • API: Report
   • Method: Run

   NOTE: You should also verify REST and 1.4 are selected under the Request tab

5. Enter the following JSON in the request box

   {
       "reportDescription":{
           "source": "realtime",
           "reportSuiteID":"rtd-example",
           "metrics":[
               {"id":"instances"}
           ]
       }
   }

6. Click "Get Response"

If all went well, you should get a JSON structure back that has a value every 5-minutes for the past hour. In this example, "instances" represents traffic for the site over each time period.

Further Reading (optional)

• There are many options that can be customized in a Real-time report. The full documentation is available here.

• More sort options can be found in the documentation.

• Read more about dateGranularity and other options in the documentation.

Continue to Lesson 2 »