MyHome.ie Data Delivery Service

<back to all web services

AnalyticsBrochureViews

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/analytics/brochureviews
AnalyticsBrochureViews Parameters:
NameParameterData TypeRequiredDescription
FromDatebodystringNo
ToDatebodystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
CorrelationIdformstringNo
ActiveUserIdformint?No
VersionformdoubleNo
RequestTypeIdformintNo
AnalyticsBrochureViewsResponse Parameters:
NameParameterData TypeRequiredDescription
BrochureViewsformList<BrochureViews>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
BaseType Parameters:
NameParameterData TypeRequiredDescription
VersionformdoubleNo
BrochureViews Parameters:
NameParameterData TypeRequiredDescription
DailyAnalyticsIDformintNo
PropertyIDformintNo
ApiKeyIDformintNo
DateformstringNo
Countformint?No

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 /analytics/brochureviews HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"FromDate":"String","ToDate":"String","ApiKey":"String","CorrelationId":"String","ActiveUserId":0,"Version":0,"RequestTypeId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"BrochureViews":[{"DailyAnalyticsID":0,"PropertyID":0,"ApiKeyID":0,"Date":"String","Count":0}],"Version":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}