Data API: Report service (REST)

Data API: Report service (REST) --Beta Release--

API Table of Contents

The Report Service lets you extract data and generate reports from Urchin tables.

Service URL:

http://server_name[:port]/services/vN/reportservice

This service provides the following methods:

• getTableList getTableList (REST) v1

  • The getTableList method lets you get the list of available tables from a specified profile.

• getData getData (REST) v1

  • The getData method lets you extract data from Urchin tables.

Here are the common structures for the defined methods:

• User

  • userId - user identifier

  • userName - user name

• Profile

  • accountId - account identifier

  • accountName - account name

  • profileId - profile identifier

  • profileName - profile name

• Tables

  • tableId - table/datamap identifier

  • dimensions[] - list of available cfields from table

    • cfield mappings are taken from lib/reporting/logformats/fieldlist.txt with prefix "u:" - ("u" stands for urchin)
    • cfield mappings are taken from lib/custom/logformats/fieldlist.txt with prefix "uc:" ("c" stands for urchin custom)

  • metrics[] - list of available ifields from table

• Record

  • recordId - record identifier

  • dimensions[] - list of extracted nameless dimension values

  • metrics[] - list of extracted named metric values