openapi: 3.2.0 info: title: App Store Connect Beta Testers API version: 4.3.1 x-platforms: app_store_connect_api: App Store Connect API description: The App Store Connect API is the standards-based REST API Apple provides to automate tasks across App Store Connect, Xcode, and Certificates, Identifiers & Profiles. servers: - url: https://api.appstoreconnect.apple.com/ security: - itc-bearer-token: [] tags: - name: Beta Testers paths: /v1/betaTesters: get: tags: - Beta Testers operationId: betaTesters_getCollection parameters: - name: filter[firstName] in: query description: filter by attribute 'firstName' schema: type: array items: type: string style: form explode: false required: false - name: filter[lastName] in: query description: filter by attribute 'lastName' schema: type: array items: type: string style: form explode: false required: false - name: filter[email] in: query description: filter by attribute 'email' schema: type: array items: type: string style: form explode: false required: false - name: filter[inviteType] in: query description: filter by attribute 'inviteType' schema: type: array items: type: string enum: - EMAIL - PUBLIC_LINK style: form explode: false required: false - name: filter[apps] in: query description: filter by id(s) of related 'apps' schema: type: array items: type: string style: form explode: false required: false - name: filter[betaGroups] in: query description: filter by id(s) of related 'betaGroups' schema: type: array items: type: string style: form explode: false required: false - name: filter[builds] in: query description: filter by id(s) of related 'builds' schema: type: array items: type: string style: form explode: false required: false - name: filter[id] in: query description: filter by id(s) schema: type: array items: type: string style: form explode: false required: false - name: sort in: query description: comma-separated list of sort expressions; resources will be sorted as specified schema: type: array items: type: string enum: - firstName - -firstName - lastName - -lastName - email - -email - inviteType - -inviteType - state - -state style: form explode: false required: false - name: fields[betaTesters] in: query description: the fields to include for returned resources of type betaTesters schema: type: array items: type: string enum: - firstName - lastName - email - inviteType - state - appDevices - apps - betaGroups - builds style: form explode: false required: false - name: fields[apps] in: query description: the fields to include for returned resources of type apps schema: type: array items: type: string enum: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false required: false - name: fields[betaGroups] in: query description: the fields to include for returned resources of type betaGroups schema: type: array items: type: string enum: - name - createdDate - isInternalGroup - hasAccessToAllBuilds - publicLinkEnabled - publicLinkId - publicLinkLimitEnabled - publicLinkLimit - publicLink - feedbackEnabled - iosBuildsAvailableForAppleSiliconMac - iosBuildsAvailableForAppleVision - app - builds - betaTesters - betaRecruitmentCriteria - betaRecruitmentCriterionCompatibleBuildCheck style: form explode: false required: false - name: fields[builds] in: query description: the fields to include for returned resources of type builds schema: type: array items: type: string enum: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures style: form explode: false required: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - apps - betaGroups - builds style: form explode: false required: false - name: limit[apps] in: query description: maximum number of related apps returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[betaGroups] in: query description: maximum number of related betaGroups returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[builds] in: query description: maximum number of related builds returned (when they are included) schema: type: integer maximum: 50 style: form required: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of BetaTesters content: application/json: schema: $ref: '#/components/schemas/BetaTestersResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Beta Testers post: tags: - Beta Testers operationId: betaTesters_createInstance requestBody: description: BetaTester representation content: application/json: schema: $ref: '#/components/schemas/BetaTesterCreateRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '201': description: Single BetaTester content: application/json: schema: $ref: '#/components/schemas/BetaTesterResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Create Beta Testers /v1/betaTesters/{id}: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Beta Testers operationId: betaTesters_getInstance parameters: - name: fields[betaTesters] in: query description: the fields to include for returned resources of type betaTesters schema: type: array items: type: string enum: - firstName - lastName - email - inviteType - state - appDevices - apps - betaGroups - builds style: form explode: false required: false - name: fields[apps] in: query description: the fields to include for returned resources of type apps schema: type: array items: type: string enum: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false required: false - name: fields[betaGroups] in: query description: the fields to include for returned resources of type betaGroups schema: type: array items: type: string enum: - name - createdDate - isInternalGroup - hasAccessToAllBuilds - publicLinkEnabled - publicLinkId - publicLinkLimitEnabled - publicLinkLimit - publicLink - feedbackEnabled - iosBuildsAvailableForAppleSiliconMac - iosBuildsAvailableForAppleVision - app - builds - betaTesters - betaRecruitmentCriteria - betaRecruitmentCriterionCompatibleBuildCheck style: form explode: false required: false - name: fields[builds] in: query description: the fields to include for returned resources of type builds schema: type: array items: type: string enum: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures style: form explode: false required: false - name: include in: query description: comma-separated list of relationships to include schema: type: array items: type: string enum: - apps - betaGroups - builds style: form explode: false required: false - name: limit[apps] in: query description: maximum number of related apps returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[betaGroups] in: query description: maximum number of related betaGroups returned (when they are included) schema: type: integer maximum: 50 style: form required: false - name: limit[builds] in: query description: maximum number of related builds returned (when they are included) schema: type: integer maximum: 50 style: form required: false responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Single BetaTester content: application/json: schema: $ref: '#/components/schemas/BetaTesterResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Beta Testers delete: tags: - Beta Testers operationId: betaTesters_deleteInstance responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '202': description: Accepted for future completion '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Delete Beta Testers /v1/betaTesters/{id}/relationships/apps: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Beta Testers operationId: betaTesters_apps_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/BetaTesterAppsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Beta Testers / Apps delete: tags: - Beta Testers operationId: betaTesters_apps_deleteToManyRelationship requestBody: description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/BetaTesterAppsLinkagesRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '202': description: Accepted for future completion '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Remove Related Beta Testers / Apps /v1/betaTesters/{id}/apps: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Beta Testers operationId: betaTesters_apps_getToManyRelated parameters: - name: fields[apps] in: query description: the fields to include for returned resources of type apps schema: type: array items: type: string enum: - accessibilityUrl - name - bundleId - sku - primaryLocale - isOrEverWasMadeForKids - subscriptionStatusUrl - subscriptionStatusUrlVersion - subscriptionStatusUrlForSandbox - subscriptionStatusUrlVersionForSandbox - contentRightsDeclaration - streamlinedPurchasingEnabled - accessibilityDeclarations - appEncryptionDeclarations - appStoreIcon - ciProduct - betaTesters - betaGroups - appStoreVersions - appTags - preReleaseVersions - betaAppLocalizations - builds - betaLicenseAgreement - betaAppReviewDetail - appInfos - appClips - appPricePoints - endUserLicenseAgreement - appPriceSchedule - appAvailabilityV2 - inAppPurchases - subscriptionGroups - gameCenterEnabledVersions - perfPowerMetrics - appCustomProductPages - inAppPurchasesV2 - promotedPurchases - appEvents - reviewSubmissions - subscriptionGracePeriod - customerReviews - customerReviewSummarizations - gameCenterDetail - appStoreVersionExperimentsV2 - alternativeDistributionKey - analyticsReportRequests - marketplaceSearchDetail - buildUploads - backgroundAssets - betaFeedbackScreenshotSubmissions - betaFeedbackCrashSubmissions - searchKeywords - webhooks - androidToIosAppMappingDetails style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of Apps with get content: application/json: schema: $ref: '#/components/schemas/AppsWithoutIncludesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Beta Testers / Apps /v1/betaTesters/{id}/relationships/betaGroups: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Beta Testers operationId: betaTesters_betaGroups_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/BetaTesterBetaGroupsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Beta Testers / Beta Groups post: tags: - Beta Testers operationId: betaTesters_betaGroups_createToManyRelationship requestBody: description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/BetaTesterBetaGroupsLinkagesRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Add Related Beta Testers / Beta Groups delete: tags: - Beta Testers operationId: betaTesters_betaGroups_deleteToManyRelationship requestBody: description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/BetaTesterBetaGroupsLinkagesRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Remove Related Beta Testers / Beta Groups /v1/betaTesters/{id}/betaGroups: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Beta Testers operationId: betaTesters_betaGroups_getToManyRelated parameters: - name: fields[betaGroups] in: query description: the fields to include for returned resources of type betaGroups schema: type: array items: type: string enum: - name - createdDate - isInternalGroup - hasAccessToAllBuilds - publicLinkEnabled - publicLinkId - publicLinkLimitEnabled - publicLinkLimit - publicLink - feedbackEnabled - iosBuildsAvailableForAppleSiliconMac - iosBuildsAvailableForAppleVision - app - builds - betaTesters - betaRecruitmentCriteria - betaRecruitmentCriterionCompatibleBuildCheck style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of BetaGroups with get content: application/json: schema: $ref: '#/components/schemas/BetaGroupsWithoutIncludesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Beta Testers / Beta Groups /v1/betaTesters/{id}/relationships/builds: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Beta Testers operationId: betaTesters_builds_getToManyRelationship parameters: - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/BetaTesterBuildsLinkagesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Beta Testers / Builds post: tags: - Beta Testers operationId: betaTesters_builds_createToManyRelationship requestBody: description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/BetaTesterBuildsLinkagesRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Add Related Beta Testers / Builds delete: tags: - Beta Testers operationId: betaTesters_builds_deleteToManyRelationship requestBody: description: List of related linkages content: application/json: schema: $ref: '#/components/schemas/BetaTesterBuildsLinkagesRequest' required: true responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Request entity error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '204': description: Success (no content) '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Remove Related Beta Testers / Builds /v1/betaTesters/{id}/builds: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Beta Testers operationId: betaTesters_builds_getToManyRelated parameters: - name: fields[builds] in: query description: the fields to include for returned resources of type builds schema: type: array items: type: string enum: - version - uploadedDate - expirationDate - expired - minOsVersion - lsMinimumSystemVersion - computedMinMacOsVersion - computedMinVisionOsVersion - iconAssetToken - processingState - buildAudienceType - usesNonExemptEncryption - preReleaseVersion - individualTesters - betaGroups - betaBuildLocalizations - appEncryptionDeclaration - betaAppReviewSubmission - app - buildBetaDetail - appStoreVersion - icons - buildBundles - buildUpload - perfPowerMetrics - diagnosticSignatures style: form explode: false - name: limit in: query description: maximum resources per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: List of Builds with get content: application/json: schema: $ref: '#/components/schemas/BuildsWithoutIncludesResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: List Related Beta Testers / Builds /v1/betaTesters/{id}/metrics/betaTesterUsages: parameters: - name: id in: path description: the id of the requested resource schema: type: string style: simple required: true get: tags: - Beta Testers operationId: betaTesters_betaTesterUsages_getMetrics parameters: - name: period in: query description: the duration of the reporting period schema: type: string enum: - P7D - P30D - P90D - P365D style: form explode: false examples: PnD: value: P7D PTnH: value: PT10H PTnM: value: PT10M PTn.nS: value: PT10.5S PnDTnHnMn.nS: value: P7DT10H10M10.5S - name: filter[apps] in: query description: filter by 'apps' relationship dimension schema: type: string style: form explode: false required: true - name: limit in: query description: maximum number of groups to return per page schema: type: integer maximum: 200 style: form responses: '400': description: Parameter error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized error(s) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '200': description: Metrics data response content: application/json: schema: $ref: '#/components/schemas/BetaTesterUsagesV1MetricResponse' '429': description: Rate limit exceeded error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' summary: Get Metrics Beta Testers / Beta Tester Usages components: schemas: ErrorSourceParameter: type: object title: Parameter properties: parameter: type: string required: - parameter ResourceLinks: type: object properties: self: type: string format: uri-reference AppsWithoutIncludesResponse: type: object title: AppsWithoutIncludesResponse properties: data: type: array items: $ref: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links DocumentLinks: type: object properties: self: type: string format: uri-reference required: - self BetaTesterBuildsLinkagesRequest: type: object properties: data: type: array items: type: object properties: type: type: string enum: - builds id: type: string required: - id - type required: - data BetaTesterState: type: string enum: - NOT_INVITED - INVITED - ACCEPTED - INSTALLED - REVOKED BetaTesterBetaGroupsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - betaGroups id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links ErrorSourcePointer: type: object title: JsonPointer properties: pointer: type: string required: - pointer PagingInformation: type: object properties: paging: type: object properties: total: type: integer limit: type: integer nextCursor: type: string required: - limit required: - paging BetaTesterCreateRequest: type: object title: BetaTesterCreateRequest properties: data: type: object properties: type: type: string enum: - betaTesters attributes: type: object properties: firstName: type: - string - 'null' lastName: type: - string - 'null' email: type: string format: email required: - email relationships: type: object properties: betaGroups: type: object properties: data: type: array items: type: object properties: type: type: string enum: - betaGroups id: type: string required: - id - type builds: type: object properties: data: type: array items: type: object properties: type: type: string enum: - builds id: type: string required: - id - type required: - attributes - type required: - data BetaTester: type: object title: BetaTester properties: type: type: string enum: - betaTesters id: type: string attributes: type: object properties: firstName: type: string lastName: type: string email: type: string format: email inviteType: $ref: '#/components/schemas/BetaInviteType' state: $ref: '#/components/schemas/BetaTesterState' appDevices: type: array items: type: object properties: model: type: string platform: type: string enum: - IOS - MAC_OS - TV_OS - WATCH_OS - VISION_OS osVersion: type: string appBuildVersion: type: string relationships: type: object properties: apps: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - apps id: type: string required: - id - type betaGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaGroups id: type: string required: - id - type builds: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - builds id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type Build: type: object title: Build properties: type: type: string enum: - builds id: type: string attributes: type: object properties: version: type: string uploadedDate: type: string format: date-time expirationDate: type: string format: date-time expired: type: boolean minOsVersion: type: string lsMinimumSystemVersion: type: string computedMinMacOsVersion: type: string computedMinVisionOsVersion: type: string iconAssetToken: $ref: '#/components/schemas/ImageAsset' processingState: type: string enum: - PROCESSING - FAILED - INVALID - VALID buildAudienceType: $ref: '#/components/schemas/BuildAudienceType' usesNonExemptEncryption: type: boolean relationships: type: object properties: preReleaseVersion: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - preReleaseVersions id: type: string required: - id - type individualTesters: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaTesters id: type: string required: - id - type betaGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaGroups id: type: string required: - id - type betaBuildLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaBuildLocalizations id: type: string required: - id - type appEncryptionDeclaration: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appEncryptionDeclarations id: type: string required: - id - type betaAppReviewSubmission: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaAppReviewSubmissions id: type: string required: - id - type app: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type buildBetaDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - buildBetaDetails id: type: string required: - id - type appStoreVersion: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type icons: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - buildIcons id: type: string required: - id - type buildBundles: type: object properties: meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - buildBundles id: type: string required: - id - type buildUpload: type: object properties: data: type: object properties: type: type: string enum: - buildUploads id: type: string required: - id - type perfPowerMetrics: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' diagnosticSignatures: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BetaTesterAppsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - apps id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links BetaGroupsWithoutIncludesResponse: type: object title: BetaGroupsWithoutIncludesResponse properties: data: type: array items: $ref: '#/components/schemas/BetaGroup' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links BuildAudienceType: type: string enum: - INTERNAL_ONLY - APP_STORE_ELIGIBLE RelationshipLinks: type: object properties: self: type: string format: uri-reference related: type: string format: uri-reference ImageAsset: type: object properties: templateUrl: type: string width: type: integer height: type: integer SubscriptionStatusUrlVersion: type: string enum: - V1 - V2 BetaTesterResponse: type: object title: BetaTesterResponse properties: data: $ref: '#/components/schemas/BetaTester' included: type: array items: oneOf: - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/BetaGroup' - $ref: '#/components/schemas/Build' discriminator: propertyName: type mapping: betaGroups: '#/components/schemas/BetaGroup' builds: '#/components/schemas/Build' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/DocumentLinks' required: - data - links BetaTesterUsagesV1MetricResponse: type: object properties: data: type: array items: type: object properties: dataPoints: type: array items: type: object properties: start: type: string format: date-time end: type: string format: date-time values: type: object properties: crashCount: type: integer sessionCount: type: integer feedbackCount: type: integer dimensions: type: object properties: apps: type: object properties: links: type: object properties: groupBy: type: string format: uri-reference related: type: string format: uri-reference data: type: string links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links ErrorResponse: type: object properties: errors: type: array items: type: object properties: id: type: string status: type: string code: type: string title: type: string detail: type: string source: oneOf: - $ref: '#/components/schemas/ErrorSourcePointer' - $ref: '#/components/schemas/ErrorSourceParameter' links: $ref: '#/components/schemas/ErrorLinks' meta: type: object additionalProperties: {} required: - code - detail - status - title BetaTesterBetaGroupsLinkagesRequest: type: object properties: data: type: array items: type: object properties: type: type: string enum: - betaGroups id: type: string required: - id - type required: - data PagedDocumentLinks: type: object properties: self: type: string format: uri-reference first: type: string format: uri-reference next: type: string format: uri-reference required: - self App: type: object title: App properties: type: type: string enum: - apps id: type: string attributes: type: object properties: accessibilityUrl: type: string format: uri name: type: string bundleId: type: string sku: type: string primaryLocale: type: string isOrEverWasMadeForKids: type: boolean subscriptionStatusUrl: type: string format: uri subscriptionStatusUrlVersion: $ref: '#/components/schemas/SubscriptionStatusUrlVersion' subscriptionStatusUrlForSandbox: type: string format: uri subscriptionStatusUrlVersionForSandbox: $ref: '#/components/schemas/SubscriptionStatusUrlVersion' contentRightsDeclaration: type: string enum: - DOES_NOT_USE_THIRD_PARTY_CONTENT - USES_THIRD_PARTY_CONTENT streamlinedPurchasingEnabled: type: boolean relationships: type: object properties: accessibilityDeclarations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appEncryptionDeclarations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEncryptionDeclarations id: type: string required: - id - type appStoreIcon: type: object properties: data: type: object properties: type: type: string enum: - buildIcons id: type: string required: - id - type ciProduct: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - ciProducts id: type: string required: - id - type betaTesters: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaGroups id: type: string required: - id - type appStoreVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersions id: type: string required: - id - type appTags: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' preReleaseVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - preReleaseVersions id: type: string required: - id - type betaAppLocalizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaAppLocalizations id: type: string required: - id - type builds: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - builds id: type: string required: - id - type betaLicenseAgreement: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaLicenseAgreements id: type: string required: - id - type betaAppReviewDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaAppReviewDetails id: type: string required: - id - type appInfos: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appInfos id: type: string required: - id - type appClips: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appClips id: type: string required: - id - type appPricePoints: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' endUserLicenseAgreement: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - endUserLicenseAgreements id: type: string required: - id - type appPriceSchedule: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appAvailabilityV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' inAppPurchases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type deprecated: true subscriptionGroups: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - subscriptionGroups id: type: string required: - id - type gameCenterEnabledVersions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - gameCenterEnabledVersions id: type: string required: - id - type perfPowerMetrics: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' appCustomProductPages: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appCustomProductPages id: type: string required: - id - type inAppPurchasesV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - inAppPurchases id: type: string required: - id - type promotedPurchases: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - promotedPurchases id: type: string required: - id - type appEvents: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appEvents id: type: string required: - id - type reviewSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - reviewSubmissions id: type: string required: - id - type subscriptionGracePeriod: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - subscriptionGracePeriods id: type: string required: - id - type customerReviews: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' customerReviewSummarizations: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' gameCenterDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - gameCenterDetails id: type: string required: - id - type appStoreVersionExperimentsV2: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - appStoreVersionExperiments id: type: string required: - id - type alternativeDistributionKey: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' analyticsReportRequests: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' marketplaceSearchDetail: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' buildUploads: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' backgroundAssets: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaFeedbackScreenshotSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' betaFeedbackCrashSubmissions: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' searchKeywords: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' webhooks: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' androidToIosAppMappingDetails: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - androidToIosAppMappingDetails id: type: string required: - id - type links: $ref: '#/components/schemas/ResourceLinks' required: - id - type BetaTesterAppsLinkagesRequest: type: object properties: data: type: array items: type: object properties: type: type: string enum: - apps id: type: string required: - id - type required: - data BetaInviteType: type: string enum: - EMAIL - PUBLIC_LINK BetaGroup: type: object title: BetaGroup properties: type: type: string enum: - betaGroups id: type: string attributes: type: object properties: name: type: string createdDate: type: string format: date-time isInternalGroup: type: boolean hasAccessToAllBuilds: type: boolean publicLinkEnabled: type: boolean publicLinkId: type: string publicLinkLimitEnabled: type: boolean publicLinkLimit: type: integer publicLink: type: string feedbackEnabled: type: boolean iosBuildsAvailableForAppleSiliconMac: type: boolean iosBuildsAvailableForAppleVision: type: boolean relationships: type: object properties: app: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - apps id: type: string required: - id - type builds: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - builds id: type: string required: - id - type betaTesters: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' meta: $ref: '#/components/schemas/PagingInformation' data: type: array items: type: object properties: type: type: string enum: - betaTesters id: type: string required: - id - type betaRecruitmentCriteria: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' data: type: object properties: type: type: string enum: - betaRecruitmentCriteria id: type: string required: - id - type betaRecruitmentCriterionCompatibleBuildCheck: type: object properties: links: $ref: '#/components/schemas/RelationshipLinks' links: $ref: '#/components/schemas/ResourceLinks' required: - id - type ErrorLinks: type: object properties: about: type: string format: uri-reference associated: oneOf: - type: string format: uri-reference - type: object properties: href: type: string format: uri-reference meta: type: object properties: source: type: string BetaTesterBuildsLinkagesResponse: type: object properties: data: type: array items: type: object properties: type: type: string enum: - builds id: type: string required: - id - type links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links BetaTestersResponse: type: object title: BetaTestersResponse properties: data: type: array items: $ref: '#/components/schemas/BetaTester' included: type: array items: oneOf: - $ref: '#/components/schemas/App' - $ref: '#/components/schemas/BetaGroup' - $ref: '#/components/schemas/Build' discriminator: propertyName: type mapping: betaGroups: '#/components/schemas/BetaGroup' builds: '#/components/schemas/Build' apps: '#/components/schemas/App' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links BuildsWithoutIncludesResponse: type: object title: BuildsWithoutIncludesResponse properties: data: type: array items: $ref: '#/components/schemas/Build' links: $ref: '#/components/schemas/PagedDocumentLinks' meta: $ref: '#/components/schemas/PagingInformation' required: - data - links securitySchemes: itc-bearer-token: type: http scheme: bearer bearerFormat: JWT