keymetrics

The keymetrics method returns key metrics for one or more profiles or spaces. Key metrics are: Page Views, Visits, Visitors (this is the sum of daily visits, which doesn't account for overlap between days, so it doesn't usually match MLA Visitors), Bounce Rate, Average Time on Site, Average Visitors per Day, Page Views per Visit, and New Visitors. Hourly data is not available for this method.

Method

GET

URI

/profiles/KeyMetrics/

/profiles/{ProfileID}/KeyMetrics/

/spaces/KeyMetrics/

/spaces/{SpaceID}/KeyMetrics/

Note: Add any optional parameters to the end of the URI. If you change the order of URI or required parameters, or place optional parameters before them, the call will not work.

Example Request

https://ws.webtrends.com/v3/Reporting/Profiles/KeyMetrics/
https://ws.webtrends.com/v3/Reporting/Profiles/15667/KeyMetrics/?start_period=2011m01d01&end_period=2011m01d31&format=xml
https://ws.webtrends.com/v3/Reporting/spaces/KeyMetrics/
https://ws.webtrends.com/v3/Reporting/spaces/8660/KeyMetrics/

Example Response

Note: The API now escapes commas within values.
<?xml version="1.0" encoding="utf-8"?>
<DimensionalReport>
    <ReportDefinition>
        <decimal name="accountID">10314</decimal>
        <string name="profileID">15667</string>
        <string name="ID">ProfileMetrics</string>
        <string name="name">Profile Metrics</string>
        <string name="Description">
        </string>
        <string name="language" />
        <list name="Dimensions">
            <Dimension>
                <string name="ID">Profile ID</string>
                <string name="name">Profile ID</string>
            </Dimension>
        </list>
        <list name="measures">
            <Measure>
                <string name="name">Page Views</string>
                <string name="ID">PageViews</string>
                <decimal name="columnID">0</decimal>
                <string name="measureFormatType" />
            </Measure>
            <Measure>
                <string name="name">Visits</string>
                <string name="ID">Visits</string>
                <decimal name="columnID">0</decimal>
                <string name="measureFormatType" />
            </Measure>
            <Measure>
                <string name="name">Visitors</string>
                <string name="ID">Visitors</string>
                <decimal name="columnID">0</decimal>
                <string name="measureFormatType" />
            </Measure>
            <Measure>
                <string name="name">New Visitors</string>
                <string name="ID">NewVisitors</string>
                <decimal name="columnID">0</decimal>
                <string name="measureFormatType" />
            </Measure>
            <Measure>
                <string name="name">Bounce Rate</string>
                <string name="ID">BounceRate</string>
                <decimal name="columnID">0</decimal>
                <string name="measureFormatType">percent</string>
            </Measure>
            <Measure>
                <string name="name">Avg Time on Site</string>
                <string name="ID">AvgTimeOnSite</string>
                <decimal name="columnID">0</decimal>
                <string name="measureFormatType">time_seconds</string>
            </Measure>
            <Measure>
                <string name="name">Avg Visitors per Day</string>
                <string name="ID">AvgVisitorsPerDay</string>
                <decimal name="columnID">0</decimal>
                <string name="measureFormatType" />
            </Measure>
            <Measure>
                <string name="name">Page Views per Visit</string>
                <string name="ID">PageViewsPerVisit</string>
                <decimal name="columnID">0</decimal>
                <string name="measureFormatType" />
            </Measure>
            <Measure>
                <string name="name">Avg Time on Site per Visitor</string>
                <string name="ID">AvgSiteTimePerVisitor</string>
                <decimal name="columnID">0</decimal>
                <string name="measureFormatType">time_seconds</string>
            </Measure>
        </list>
    </ReportDefinition>
    <list name="data" />
</DimensionalReport>

Parameters