다음을 통해 공유


날짜 또는 약관별로 그룹화된 구독 분석 가져오기

적용 대상: 파트너 센터 | 21Vianet에서 운영되는 파트너 센터 | Microsoft Cloud for US Government 파트너 센터

날짜 또는 약관별로 그룹화된 고객에 대한 구독 분석 정보를 가져오는 방법입니다.

필수 구성 요소

  • 자격 증명(파트너 센터 인증에서 설명). 이 시나리오에서는 사용자 자격 증명으로만 인증을 지원합니다.

REST 요청

요청 구문

방법 요청 URI
GET {baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

URI 매개 변수

다음 필수 경로 매개 변수를 사용하여 organization 식별하고 결과를 그룹화합니다.

Name 형식 필수 Description
groupby_queries 문자열 및 dateTime 쌍 Yes 결과를 필터링할 사용 약관 및 날짜입니다.

GroupBy 구문

매개 변수별 그룹은 일련의 쉼표로 구분된 필드 값으로 구성되어야 합니다.

인코딩되지 않은 예제는 와 같습니다.

?groupby=termField1,dateField1,termField2

다음 표에는 그룹화 기준에서 지원되는 필드 목록이 나와 있습니다.

필드 형식 Description
customerTenantId 문자열 고객 테넌트를 식별하는 GUID 형식 문자열입니다.
customerName 문자열 고객의 이름입니다.
customerMarket 문자열 고객이 비즈니스를 수행하는 국가/지역입니다.
id 문자열 구독을 식별하는 GUID 형식 문자열입니다.
상태 문자열 구독 상태입니다. 지원되는 값은 "ACTIVE", "SUSPENDED" 또는 "DEPROVISIONED"입니다.
productName 문자열 제품의 이름입니다.
subscriptionType 문자열 구독 유형입니다. 참고: 이 필드는 대/소문자를 구분합니다. 지원되는 값은 "Office", "Azure", "Microsoft365", "Dynamics", "EMS"입니다.
autoRenewEnabled 부울 구독이 자동으로 갱신되는지 여부를 나타내는 값입니다.
partnerId 문자열 PartnerID입니다. 직접 재판매인의 경우 이 매개 변수는 파트너의 PartnerID가 됩니다. 간접 재판매인의 경우 이 매개 변수는 간접 재판매인의 PartnerID가 됩니다.
friendlyName 문자열 구독 이름입니다.
partnerName 문자열 구독을 구매한 파트너의 이름
providerName 문자열 구독 트랜잭션이 간접 재판매인의 경우 공급자 이름은 구독을 구입한 간접 공급자입니다.
creationDate UTC 날짜/시간 형식의 문자열 구독을 만든 날짜입니다.
effectiveStartDate UTC 날짜/시간 형식의 문자열 구독이 시작되는 날짜입니다.
commitmentEndDate UTC 날짜/시간 형식의 문자열 구독이 종료되는 날짜입니다.
currentStateEndDate UTC 날짜/시간 형식의 문자열 구독의 현재 상태 변경되는 날짜입니다.
trialToPaidConversionDate UTC 날짜/시간 형식의 문자열 구독이 평가판에서 유료로 변환되는 날짜입니다. 기본값은 null입니다.
trialStartDate UTC 날짜/시간 형식의 문자열 구독의 평가판 기간이 시작된 날짜입니다. 기본값은 null입니다.
lastUsageDate UTC 날짜/시간 형식의 문자열 구독이 마지막으로 사용된 날짜입니다. 기본값은 null입니다.
deprovisionedDate UTC 날짜/시간 형식의 문자열 구독이 프로비전 해제된 날짜입니다. 기본값은 null입니다.
lastRenewalDate UTC 날짜/시간 형식의 문자열 구독이 마지막으로 갱신된 날짜입니다. 기본값은 null입니다.

필드 필터링

다음 표에는 선택적 필터 필드 및 해당 설명이 나와 있습니다.

필드 형식 Description
top int 요청에서 반환할 데이터의 행의 수입니다. 값을 지정하지 않으면 최대값과 기본값은 10000입니다. 쿼리에 더 많은 행이 있는 경우 응답 본문에 데이터의 다음 페이지를 요청하는 데 사용할 수 있는 다음 링크가 포함되어 있습니다.
skip int 쿼리에서 건너뛸 행의 수입니다. 이 매개 변수를 사용하여 큰 데이터 집합의 페이지를 탐색할 수 있습니다. 예를 들어 top=10000 및 skip=0은 처음 10000개의 데이터 행을 검색하고 top=10000 및 skip=10000은 다음 10000개의 데이터 행을 검색합니다.
filter 문자열 응답에서 행을 필터링하는 하나 이상의 문입니다. 각 필터 문에는 응답 본문의 필드 이름과 , ne또는 특정 필드의 연산자와 연결된 eq값이 contains 포함됩니다. 또는 or을 사용하여 and 문을 결합할 수 있습니다. 문자열 값은 filter 매개 변수에서 단일 따옴표로 묶여야 합니다. 필터링할 수 있는 필드 목록과 해당 필드에서 지원되는 연산자는 다음 섹션을 참조하세요.
aggregationLevel 문자열 집계 데이터를 검색할 시간 범위를 지정합니다. day, week 또는 month 문자열 중 하나일 수 있습니다. 값을 지정하지 않으면 기본값은 dateRange입니다. 참고: 이 매개 변수는 date 필드가 groupBy 매개 변수의 일부로 전달되는 경우에만 적용됩니다.
Groupby 문자열 지정된 필드에 대한 데이터 집계에만 적용되는 문입니다.

요청 헤더

자세한 내용은 파트너 센터 REST 헤더를 참조하세요.

요청 본문

없음

요청 예제

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?groupBy=subscriptionType
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Content-Type: application/json
Content-Length: 0

REST 응답

성공하면 응답 본문에 지정된 사용 약관 및 날짜별로 그룹화된 구독 리소스 컬렉션이 포함됩니다.

응답 성공 및 오류 코드

각 응답에는 성공 또는 실패와 추가 디버깅 정보를 나타내는 HTTP 상태 코드가 함께 제공됩니다. 네트워크 추적 도구를 사용하여 이 코드, 오류 유형 및 추가 매개 변수를 읽을 수 있습니다. 전체 목록은 오류 코드를 참조하세요.

응답 예제

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: aaaa0000-bb11-2222-33cc-444444dddddd
{
  "Value": [
    {
      "subscriptionType": "Azure",
      "subscriptionCount": "63",
      "licenseCount": "0"
    },
    {
      "subscriptionType": "Dynamics",
      "subscriptionCount": "62",
      "licenseCount": "405"
    },
    {
      "subscriptionType": "EMS",
      "subscriptionCount": "39",
      "licenseCount": "193"
    },
    {
      "subscriptionType": "M365",
      "subscriptionCount": "2",
      "licenseCount": "5"
    },
    {
      "subscriptionType": "Office",
      "subscriptionCount": "906",
      "licenseCount": "7485"
    },
    {
      "subscriptionType": "UNKNOWN",
      "subscriptionCount": "104",
      "licenseCount": "439"
    },
    {
      "subscriptionType": "Windows",
      "subscriptionCount": "2",
      "licenseCount": "2"
    }
  ],
  "@nextLink": null,
  "TotalCount": 7
}

추가 정보

파트너 센터 분석 - 리소스