Jaa


Get all referrals analytics information

Applies to: Partner Center | Partner Center for Microsoft Cloud for US Government

How to get all the referrals analytics information for your customers.

Prerequisites

REST request

Request syntax

Method Request URI
GET {baseURL}/partner/v1/analytics/referrals HTTP/1.1

URI parameters

Parameter Type Description
filter string Returns data matching the filter condition.
Example:
.../referrals?filter=field eq 'value'
groupby string Supports both terms and dates. Short circuit logic to limit the number of buckets.
Example:
.../referrals?groupby=termField1,dateField1,termField2
aggregationLevel string The aggregationLevel parameter requires a groupby. The aggregationLevel parameter applies to all date fields present in the groupby.
Example:
.../referrals?groupby=termField1,dateField1,termField2&aggregationLevel=day
top string The page limit is 10000. Takes any value less than 10000.
Example:
.../referrals?top=100
skip string Number of rows to skip.
Example:
.../referrals?top=100&skip=100

Request headers

For more information, see Partner Center REST headers.

Request body

None.

Request example

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/referrals HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 0

REST response

If successful, the response body contains a collection of Referrals resources.

Response success and error codes

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters. For the full list, see Error Codes.

Response example

{
  "id": "112310",
  "status": "Accepted",
  "customerMarket": "US",
  "customerName": "Best Customer Ever",
  "customerOrgSize": "10to50employees",
  "acceptedDate": "2018-02-07T23:43:19",
  "acknowledgedDate": "2018-02-07T23:40:50",
  "archivedDate": null,
  "declinedDate": null,
  "expiredDate": null,
  "lostDate": null,
  "missedDate": null,
  "createdDate": "2018-02-04T23:08:59",
  "skippedDate": null,
  "wonDate": null,
  "partnerMarket": "US"
}

See also