<back to all web services

GetCustomMetricValuesMessage

The following routes are available for this service:
All Verbs/RestApi/Sitefinity/Analytics/GetCustomMetricValues
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Telerik.Sitefinity.Analytics.Server.Infrastructure.Services.ServiceStackServices.Model;
using Telerik.Sitefinity.Analytics.Server.Core.Domain.DTO;

namespace Telerik.Sitefinity.Analytics.Server.Core.Domain.DTO
{
    [DataContract]
    public partial class AnalyticsItem
    {
        [DataMember]
        public virtual IEnumerable<DimensionItem> Dimensions { get; set; }

        [DataMember]
        public virtual IEnumerable<MetricItem> Metrics { get; set; }

        [DataMember]
        public virtual double TotalItems { get; set; }
    }

    [DataContract]
    public partial class DimensionItem
    {
        [DataMember]
        public virtual string Value { get; set; }

        [DataMember]
        public virtual string Name { get; set; }
    }

    [DataContract]
    public partial class MetricItem
    {
        [DataMember]
        public virtual double Value { get; set; }
    }

}

namespace Telerik.Sitefinity.Analytics.Server.Infrastructure.Services.ServiceStackServices.Model
{
    public partial class GetCustomMetricValuesData
    {
        public GetCustomMetricValuesData()
        {
            Result = new List<AnalyticsItem>{};
            MetricDisplayNames = new List<string>{};
        }

        public virtual List<AnalyticsItem> Result { get; set; }
        public virtual List<string> MetricDisplayNames { get; set; }
    }

    public partial class GetCustomMetricValuesMessage
    {
        public GetCustomMetricValuesMessage()
        {
            MetricNames = new string[]{};
        }

        public virtual string[] MetricNames { get; set; }
        public virtual int LastNDays { get; set; }
        public virtual int MaxNDays { get; set; }
        public virtual Guid SiteId { get; set; }
    }

}

C# 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"]}