<back to all web services

GetCustomMetricValuesMessage

The following routes are available for this service:
All Verbs/RestApi/Sitefinity/Analytics/GetCustomMetricValues
GetCustomMetricValuesMessage Parameters:
NameParameterData TypeRequiredDescription
MetricNamesquerystring[]No
LastNDaysqueryintNo
MaxNDaysqueryintNo
SiteIdqueryGuidNo
GetCustomMetricValuesData Parameters:
NameParameterData TypeRequiredDescription
ResultformList<AnalyticsItem>No
MetricDisplayNamesformList<string>No
AnalyticsItem Parameters:
NameParameterData TypeRequiredDescription
DimensionsformIEnumerable<DimensionItem>No
MetricsformIEnumerable<MetricItem>No
TotalItemsformdoubleNo
DimensionItem Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo
NameformstringNo
MetricItem Parameters:
NameParameterData TypeRequiredDescription
ValueformdoubleNo

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetCustomMetricValuesMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Infrastructure.Services.ServiceStackServices.Model">
  <LastNDays>0</LastNDays>
  <MaxNDays>0</MaxNDays>
  <MetricNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </MetricNames>
  <SiteId>00000000-0000-0000-0000-000000000000</SiteId>
</GetCustomMetricValuesMessage>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCustomMetricValuesData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Infrastructure.Services.ServiceStackServices.Model">
  <MetricDisplayNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </MetricDisplayNames>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Analytics.Server.Core.Domain.DTO">
    <d2p1:AnalyticsItem i:nil="true" />
  </Result>
</GetCustomMetricValuesData>