MetricsApiService

Namespace http://api.hi5.com/metrics (wsdl):

These services are used to request statistical data about applications.

The following methods are available on this endpoint:

getMetricsDaily

Provides daily metrics for one or several applications. This call will show break down of metrics by day, as well as summary over all days within the specified date range. The date format is yyyy-MM-dd. The range must be no bigger than 30 days. If no range is provided, last available day is retrieved.

Input Parameters

name description
api_keys list of api keys corresponding to applications. Parameter "all" will display metrics for all applications of which the caller is a developer of. If no keys are provided, the key from the authorization tpoken will be used
appIdList (no documentation provided)
metrics Metrics to display. If no parameter is provided, all available metrics are shown. For the list of available metrics check the metrics/total api.
contexts Specific contexts in which metrics were taken. If none provided, the breakdown of metrics by context is not displayed and the count is shown over all contexts. Keyword "all" will also provide the count over all contexts but will show the breakdown as well. For the list of available contexts check the metrics/total api
startTime start of the time period, yesterday
endTime end of the time period, by default

Return Value

list of metrics by day

Faults

name description
Hi5ApiGeneralException (no documentation provided)
PermissionDeniedException (no documentation provided)

getMetricsDailyUniques

Same as metrics/daily api, only displays uniques

Input Parameters

name description
api_keys (no documentation provided)
appIdList (no documentation provided)
metrics (no documentation provided)
contexts (no documentation provided)
startTime (no documentation provided)
endTime (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
Hi5ApiGeneralException (no documentation provided)
PermissionDeniedException (no documentation provided)

getMetricsHourly

Provides hourly metrics for one or several applications. This call will show break down of metrics by hour, as well as summary over all hours within the specified date range. The time format is yyyy-MM-dd-hh. The hour must be an number from 0 to 23. The range must be no bigger than 24 hours. If no range is provided, available data for last 24 hours will be shown Parameters are same as metrics/daily api.

Input Parameters

name description
api_keys (no documentation provided)
appIdList (no documentation provided)
metrics (no documentation provided)
contexts (no documentation provided)
startTime (no documentation provided)
endTime (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
Hi5ApiGeneralException (no documentation provided)
PermissionDeniedException (no documentation provided)

getMetricsHourlyUniques

Same as metrics/hourly api, only displays uniques

Input Parameters

name description
api_keys (no documentation provided)
appIdList (no documentation provided)
metrics (no documentation provided)
contexts (no documentation provided)
startTime (no documentation provided)
endTime (no documentation provided)

Return Value

(no documentation provided)

Faults

name description
Hi5ApiGeneralException (no documentation provided)
PermissionDeniedException (no documentation provided)

getMetricsTotal

Provides statistics over the whole lifespan of one or several apps.

Input Parameters

name description
api_keys list of api keys corresponding to applications. Parameter "all" will display metrics for all applications of which the caller is a developer of. If no keys are provided, the key from the authorization tpoken will be used
appIdList (no documentation provided)
metrics Metrics to display. If no parameter is provided, all available metrics are shown.
    Here is the list of available metrics
  • install : Total number of installs
  • remove : Total number of removes. You will have to subtract this from the total number of installs to get the net installs of your application for the applicable time period.
  • preview : Calls to the preview module
  • canvas : Calls to the canvas module
  • block : Block requests generated in response to emails and notifications generated by your application_,_ and on the My Applications page.
  • invite_requested : Application Invite requests generated. Note that this counts a request containing multiple friends as one request
  • invite_sent : Application Invite requests fulfilled
  • report_abuse : Notifications generated by your application marked as spam
  • notification_requested : Notification API requests made to the API servers
  • notification_sent : Notification API requests fulfilled. Note that when an API request is fulfilled, not all the recipients in the API request might receive the request, as some might already have received the limit of per-recipient notifications allowed.
  • activity_requested : Requests to generate a Friend Update
  • activity_sent : Friend Update requests fulfilled
  • view_profile : Calls to the profile module
  • api_request : API requests sent to our API servers by your application
  • email_requested : Number of requests to send a message
  • email_sent : Numbner of message sent
  • friend_request_requested : Number of friend requests made by an application
  • friend_request_sent : Friend request fulfilled
  • all : List all available metrics
contexts Specific contexts in which metrics were taken. If none provided, the breakdown of metrics by context is not displayed and the count is shown over all contexts. Keyword "all" will also provide the count over all contexts but will show the breakdown as well.
    Here is the list of available contexts
  • own_profile : The profile of the currently logged-in user
  • other_profile : The profile of someone other than the currently logged-in user
  • gallery : Application Gallery
  • activity_stream : Friend update stream.
  • invite : Friend Invite.
  • notification : Notification.
  • developer_center : Developer page.
  • myapps : Manage Applications page.
  • homepage : User's home page.
  • profilenav : The View More link on the Profile module, and from the Applications drop down in the navigation bar at the top of the Profile page
  • canvas : Application canvas
  • apphome_owner : My Applications page of the currently logged-in user when user clicks on one of their own apps.
  • apphome_friend : My Applications page of the currently logged-in user when user clicks on one of their friend's apps.
  • request_share_app Application Invite.
  • unknown : All other or when context that wasn't determined. Api requests, for example, don't have a context.
  • all : show breakdown by all contexts

Return Value

list of metrics for requested apps

Faults

name description
Hi5ApiGeneralException (no documentation provided)
PermissionDeniedException (no documentation provided)

Comments

Home

SOAP

REST

Data Types