• App versions
  • Applications
  • Apps
  • Assets
  • Categories
  • License types
  • Migrations
  • Privacy and Security
  • Products
  • Promotions (Removed)
  • Reporting
  • Reviews
  • Vendors
Platform
Atlassian Marketplace / Reference / Marketplace REST API (v2)

Reporting

Postman Collection
OpenAPI

Information about vendor reporting

Operations
GET/vendors/{vendorId}/reportingGET/vendors/{vendorId}/reporting/evaluations/{metric}GET/vendors/{vendorId}/reporting/feedback/detailsGET/vendors/{vendorId}/reporting/feedback/details/exportGET/vendors/{vendorId}/reporting/feedback/metrics/{metric}GET/vendors/{vendorId}/reporting/licensesGET/vendors/{vendorId}/reporting/licenses/exportPOST/vendors/{vendorId}/reporting/licenses/async/exportGET/vendors/{vendorId}/reporting/licenses/async/export/{exportId}/statusGET/vendors/{vendorId}/reporting/licenses/async/export/{exportId}POST/vendors/{vendorId}/reporting/marketing-attribution/async/exportGET/vendors/{vendorId}/reporting/async/export/{exportId}/statusGET/vendors/{vendorId}/reporting/async/export/{exportId}GET/vendors/{vendorId}/reporting/sales/metrics/churnGET/vendors/{vendorId}/reporting/sales/metrics/conversionGET/vendors/{vendorId}/reporting/sales/metrics/renewalGET/vendors/{vendorId}/reporting/sales/metrics/{saleMetric}/detailsGET/vendors/{vendorId}/reporting/sales/metrics/{saleMetric}/details/exportGET/vendors/{vendorId}/reporting/sales/transactionsGET/vendors/{vendorId}/reporting/sales/transactions/exportPOST/vendors/{vendorId}/reporting/sales/transactions/async/exportGET/vendors/{vendorId}/reporting/sales/transactions/async/export/{exportId}/statusGET/vendors/{vendorId}/reporting/sales/transactions/async/export/{exportId}GET/vendors/{vendorId}/reporting/sales/transactions/{metric}GET/vendors/{vendorId}/reporting/sales/freeStarterTier/exportGET/vendors/{vendorId}/reporting/sales/metrics/churn/benchmarkGET/vendors/{vendorId}/reporting/benchmark/evaluationsGET/vendors/{vendorId}/reporting/benchmark/salesGET/vendors/{vendorId}/reporting/customer-insights/regionsGET/vendors/{vendorId}/reporting/customer-insights/editionsGET/vendors/{vendorId}/reporting/customer-insights/active-usersGET/vendors/{vendorId}/reporting/customer-insights/tiersGET/vendors/{vendorId}/reporting/search-keywords/source/{sourceKey}GET/vendors/{vendorId}/reporting/search-keywords/source/{sourceKey}/exportGET/vendors/{vendorId}/reporting/zero-search-results-keywords/source/{sourceKey}GET/vendors/{vendorId}/reporting/zero-search-results-keywords/source/{sourceKey}/exportGET/vendors/{vendorId}/reporting/search-keywordsGET/vendors/{vendorId}/reporting/search-keywords/exportGET/vendors/{vendorId}/addons/{addonKey}/reporting/search-keywordsGET/vendors/{vendorId}/addons/{addonKey}/reporting/search-keywords/exportGET/vendors/{vendorId}/reporting/app-requests-and-approvalsPOST/vendors/{vendorId}/partner-metrics
GET

Get reporting links

Get links to permitted vendor reporting resources. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Responses

application/json

VendorReporting
GET/vendors/{vendorId}/reporting
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "cloudChurn": [ { "template": "<string>", "type": "<string>", "name": "<string>" } ], "cloudConversions": [ { "template": "<string>", "type": "<string>", "name": "<string>" } ], "cloudRenewals": [ { "template": "<string>", "type": "<string>", "name": "<string>" } ], "evaluationsByCountry": { "template": "<string>", "type": "<string>", "name": "<string>" }, "evaluationsByHosting": { "template": "<string>", "type": "<string>", "name": "<string>" }, "evaluationsByPartner": { "template": "<string>", "type": "<string>", "name": "<string>" }, "evaluationsByRegion": { "template": "<string>", "type": "<string>", "name": "<string>" }, "feedbackLinks": [ { "template": "<string>", "type": "<string>", "name": "<string>" } ], "licenses": { "template": "<string>", "type": "<string>", "name": "<string>" }, "licensesExport": [ { "template": "<string>", "type": "<string>", "name": "<string>" } ], "transactions": { "template": "<string>", "type": "<string>", "name": "<string>" }, "transactionsExport": [ { "template": "<string>", "type": "<string>", "name": "<string>" } ], "transactionsByCountry": { "template": "<string>", "type": "<string>", "name": "<string>" }, "transactionsByHosting": { "template": "<string>", "type": "<string>", "name": "<string>" }, "transactionsByPartner": { "template": "<string>", "type": "<string>", "name": "<string>" }, "transactionsByRegion": { "template": "<string>", "type": "<string>", "name": "<string>" }, "transactionsByTier": { "template": "<string>", "type": "<string>", "name": "<string>" }, "transactionsByType": { "template": "<string>", "type": "<string>", "name": "<string>" } } }
GET

Get aggregated evaluations

Get aggregated evaluations for the specified vendor, aggregated by the specified metric. Evaluations can be aggregated by hosting, region, and more. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required
metric

string

Required

Query parameters

aggregation

string

startDate

string

endDate

string

Responses

application/json

AggregatedAddonsWithTotal

Collection of aggregated series of a vendor's sale data

GET/vendors/{vendorId}/reporting/evaluations/{metric}
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/evaluations/{metric}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "total": { "name": "<string>", "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 73 } ] } ] }, "addons": [ { "addonKey": "<string>", "name": "<string>", "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 73 } ] } ] } ] }
GET

Get feedback

Get a list of feedback for the specified vendor's apps. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

type

array<string>

anonymous

boolean

reason

array<string>

addon

array<string>

hosting

array<string>

startDate

string

endDate

string

text

string

offset

integer

limit

integer

Responses

application/json

VendorFeedbackCollection

A collection of feedback received for the app

GET/vendors/{vendorId}/reporting/feedback/details
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/feedback/details' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" }, "next": { "href": "<string>", "type": "<string>", "title": "<string>" }, "prev": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "feedback": [ { "addonKey": "<string>", "addonName": "<string>", "addonVersion": "<string>", "applicationKey": "<string>", "applicationVersion": "<string>", "hosting": "<string>", "date": "<string>", "feedbackType": "disable", "reasonKey": "<string>", "message": "<string>", "email": "<string>", "fullName": "<string>", "licenseId": "<string>", "appEntitlementId": "<string>", "appEntitlementNumber": "<string>", "cloudId": "<string>" } ] }
GET

Export feedback

Export all feedback, matching the specified filters, for the specified vendor's apps. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

type

array<string>

anonymous

boolean

reason

array<string>

addon

array<string>

hosting

array<string>

startDate

string

endDate

string

text

string

accept

string

Responses

This status code has no content.

GET/vendors/{vendorId}/reporting/feedback/details/export
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/feedback/details/export' \ --user 'email@example.com:<api_token>'
GET

Get aggregated feedback

Get aggregated feedback for the specified vendor, aggregated by the specified metric. Feedback can be aggregated by type and reason. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required
metric

string

Required

Query parameters

aggregation

string

startDate

string

endDate

string

Responses

application/json

AggregatedFeedbacksWithTotal

Collection of aggregated series of feedback data

GET/vendors/{vendorId}/reporting/feedback/metrics/{metric}
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/feedback/metrics/{metric}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "total": { "name": "<string>", "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 57 } ] } ] }, "addons": [ { "addonKey": "<string>", "name": "<string>", "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 57 } ] } ] } ] }
GET

Get licenses

Get a list of licenses for the specified vendor's apps. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

addon

array<string>

startDate

string

endDate

string

text

string

tier

array<integer>

dateType

string

licenseType

array<string>

partnerType

array<string>

hosting

array<string>

status

array<string>

Responses

application/json

LicenseCollection

Collection of licenses for the vendor's apps

GET/vendors/{vendorId}/reporting/licenses
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/licenses' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" }, "export": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ], "next": { "href": "<string>", "type": "<string>", "title": "<string>" }, "prev": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "licenses": [ { "addonLicenseId": "<string>", "appEntitlementId": "<string>", "appEntitlementNumber": "<string>", "hostLicenseId": "<string>", "hostEntitlementId": "<string>", "hostEntitlementNumber": "<string>", "licenseId": "<string>", "cloudId": "<string>", "cloudSiteHostname": "<string>", "addonKey": "<string>", "addonName": "<string>", "hosting": "<string>", "lastUpdated": "<string>", "licenseType": "<string>", "maintenanceStartDate": "<string>", "maintenanceEndDate": "<string>", "status": "<string>", "tier": "<string>", "cmtDetails": { "status": "<string>", "relatedOnPremLicense": "<string>" }, "contactDetails": { "company": "<string>", "country": "<string>", "region": "<string>", "technicalContact": {}, "billingContact": {} }, "partnerDetails": { "partnerName": "<string>", "partnerType": "<string>", "billingContact": {} }, "attribution": { "channel": "<string>", "referrerDomain": "<string>", "campaignSource": "<string>", "campaignMedium": "<string>", "campaignName": "<string>", "campaignContent": "<string>" }, "extendedServerSupport": "<string>", "licenseSourceType": "<string>", "evaluationOpportunitySize": "<string>", "evaluationLicense": "<string>", "daysToConvertEval": "<string>", "evaluationStartDate": "<string>", "evaluationEndDate": "<string>", "evaluationSaleDate": "<string>", "parentProductBillingCycle": "<string>", "parentProductName": "<string>", "parentProductEdition": "<string>", "installedOnSandbox": "<string>", "transactionAccountId": "<string>" } ] }
GET

Export licenses

Export all licenses, matching the specified filters, for the specified vendor's apps. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

addon

array<string>

startDate

string

endDate

string

text

string

tier

array<integer>

dateType

string

licenseType

array<string>

partnerType

array<string>

hosting

array<string>

status

array<string>

Responses

Content downloaded will be the csv/json file

GET/vendors/{vendorId}/reporting/licenses/export
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/licenses/export' \ --user 'email@example.com:<api_token>'
POST

Initiate Async Export licenses

Initiate a POST request to export all licenses that match the specified filters for the vendor's apps. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

addon

array<string>

startDate

string

endDate

string

text

string

tier

array<integer>

dateType

string

licenseType

array<string>

partnerType

array<string>

hosting

array<string>

status

array<string>

Responses

application/json

InitiateAsyncLicenseCollection

Initiate licenses export request for the vendor's apps

POST/vendors/{vendorId}/reporting/licenses/async/export
1 2 3 4 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/licenses/async/export' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "href": "<string>", "type": "<string>", "title": "<string>" }, "status": { "href": "<string>", "type": "<string>", "title": "<string>" }, "download": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "export": { "id": "<string>" } }
GET

Get status Async Export licenses

Get status for async export license request

Request

Path parameters

vendorId

integer

Required
exportId

string

Required

Responses

application/json

StatusAsyncLicenseCollection

Get Status for licenses export request for the vendor's apps

GET/vendors/{vendorId}/reporting/licenses/async/export/{exportId}/status
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/licenses/async/export/{exportId}/status' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "href": "<string>", "type": "<string>", "title": "<string>" }, "download": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "export": { "id": "<string>", "status": "QUEUED" } }
GET

Download Async Export licenses

Download async export licenses

Request

Path parameters

vendorId

integer

Required
exportId

string

Required

Responses

Content downloaded will be the csv/json file

GET/vendors/{vendorId}/reporting/licenses/async/export/{exportId}
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/licenses/async/export/{exportId}' \ --user 'email@example.com:<api_token>'
POST

Initiate Async Export marketing attribution

Initiate a POST request to export all marketing attribution data that matches the specified filters for the vendor's apps. The data will include customer activities on app related pages in the last 30 days before start of evaluation. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

addon

array<string>

startDate

string

endDate

string

text

string

accept

string

Responses

application/json

InitiateAsyncMarketingAttributionCollection

Initiate marketing attribution export request for the vendor's apps

POST/vendors/{vendorId}/reporting/marketing-attribution/async/export
1 2 3 4 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/marketing-attribution/async/export' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 { "_links": { "self": { "href": "<string>", "type": "<string>&quo