<back to all web services

GetCustomMetricValuesMessage

The following routes are available for this service:
All Verbs/RestApi/Sitefinity/Analytics/GetCustomMetricValues
namespace Telerik.Sitefinity.Analytics.Server.Core.Domain.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type GetCustomMetricValuesMessage() = 
        member val MetricNames:String[] = [||] with get,set
        member val LastNDays:Int32 = new Int32() with get,set
        member val MaxNDays:Int32 = new Int32() with get,set
        member val SiteId:Guid = new Guid() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type DimensionItem() = 
        [<DataMember>]
        member val Value:String = null with get,set

        [<DataMember>]
        member val Name:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type MetricItem() = 
        [<DataMember>]
        member val Value:Double = new Double() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AnalyticsItem() = 
        [<DataMember>]
        member val Dimensions:IEnumerable<DimensionItem> = null with get,set

        [<DataMember>]
        member val Metrics:IEnumerable<MetricItem> = null with get,set

        [<DataMember>]
        member val TotalItems:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type GetCustomMetricValuesData() = 
        member val Result:ResizeArray<AnalyticsItem> = new ResizeArray<AnalyticsItem>() with get,set
        member val MetricDisplayNames:ResizeArray<String> = new ResizeArray<String>() with get,set

F# GetCustomMetricValuesMessage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /RestApi/Sitefinity/Analytics/GetCustomMetricValues HTTP/1.1 
Host: www.asg.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"MetricNames":["String"],"LastNDays":0,"MaxNDays":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Result":[{}],"MetricDisplayNames":["String"]}