GET api/memberstats/getsingle
Get statistics about a member's sharing, referral, and reward activities.
Request Information
URI Parameters
Query String: query={query}&timePeriod={timePeriod}
| Name | Description | Type | Additional information |
|---|---|---|---|
| query |
A member must have this value as its email address, id, external id, or referral code. |
string |
Required |
| timePeriod |
A duration of time to retrieve statistics for. Valid time periods are as follows: All, MonthToDate, LastMonth, Last7Days, and Last30Days. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
[HTTP Status 200 - OK] Statistics about a member’s participation in a referral program.
Type: MemberStatistics
| Name | Description | Type | Additional information |
|---|---|---|---|
| memberViews |
Member's total views. |
integer |
None. |
| memberShares |
Number of times a member share link was followed. |
integer |
None. |
| referralsCount |
Number of referrals a member has. |
integer |
None. |
| lastShare |
The last date the member shared a link to the program. |
date |
None. |
| referralsApproved |
The number of member referrals which have been approved. |
integer |
None. |
| referralsQualified |
The number of member referrals which have qualified. |
integer |
None. |
| referralsPending |
The number of member referrals which are pending. |
integer |
None. |
| referralsViews |
The number of times referrals have viewed their referring member's webpage. |
integer |
None. |
| referralsApprovedAmount |
The amount spent by an approved referral, if the value is in our system. |
decimal number |
None. |
| rewardsPendingAmount |
The value of rewards in pending status, which were generated by the member. |
decimal number |
None. |
| rewardsIssuedAmount |
The value of rewards that have been issued and were generated by the member. |
decimal number |
None. |
| rewardAmountTotal |
The sum of the value of issued and pending rewards generated by the member. |
decimal number |
None. |
| rewardsCount |
The number of rewards generated by the member. |
integer |
None. |
Response Formats
application/json, text/json
{
"memberViews": 1,
"memberShares": 2,
"referralsCount": 3,
"lastShare": "2024-04-29T08:17:09.734659Z",
"referralsApproved": 4,
"referralsQualified": 5,
"referralsPending": 6,
"referralsViews": 7,
"referralsApprovedAmount": 8.0,
"rewardsPendingAmount": 9.0,
"rewardsIssuedAmount": 10.0,
"rewardAmountTotal": 11.0,
"rewardsCount": 12
}
application/xml, text/xml
<MemberStatistics xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <memberViews>1</memberViews> <memberShares>2</memberShares> <referralsCount>3</referralsCount> <lastShare>2024-04-29T08:17:09.734659+00:00</lastShare> <referralsApproved>4</referralsApproved> <referralsQualified>5</referralsQualified> <referralsPending>6</referralsPending> <referralsViews>7</referralsViews> <referralsApprovedAmount>8</referralsApprovedAmount> <rewardsPendingAmount>9</rewardsPendingAmount> <rewardsIssuedAmount>10</rewardsIssuedAmount> <rewardAmountTotal>11</rewardAmountTotal> <rewardsCount>12</rewardsCount> </MemberStatistics>