• 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

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 { "_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>", "evaluationOpportunitySize": "<string>", "evaluationLicense": "<string>", "daysToConvertEval": "<string>", "evaluationStartDate": "<string>", "evaluationEndDate": "<string>", "evaluationSaleDate": "<string>", "parentProductBillingCycle": "<string>", "parentProductName": "<string>", "parentProductEdition": "<string>", "installedOnSandbox": "<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>", "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 marketing attribution

Get status for async export marketing attribution request.

Request

Path parameters

vendorId

integer

Required
exportId

string

Required

Responses

application/json

StatusAsyncMarketingAttributionCollection

Get Status for marketing attribution export request for the vendor's apps

GET/vendors/{vendorId}/reporting/async/export/{exportId}/status
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/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 marketing attribution

Download async export marketing attribution.

Request

Path parameters

vendorId

integer

Required
exportId

string

Required

Responses

Content downloaded will be the csv/json file

application/json

MarketingAttributionCollection

Collection of activities for marketing attribution for the vendor's apps

GET/vendors/{vendorId}/reporting/async/export/{exportId}
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/async/export/{exportId}' \ --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 { "marketingAttribution": [ { "addonLicenseId": "<string>", "appEntitlementId": "<string>", "appEntitlementNumber": "<string>", "addonKey": "<string>", "channel": "<string>", "referrerDomain": "<string>", "marketplaceURL": "<string>", "campaignSource": "<string>", "campaignMedium": "<string>", "campaignName": "<string>", "campaignContent": "<string>", "eventTimestamp": "<string>", "userId": "<string>", "userType": "<string>" } ] }
GET

Get Cloud churn

Get a list of Cloud churn events for the specified vendor's apps. For a given period, churn is calculated as the number of paying customers that have an opportunity to renew and choose to stop paying. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

aggregation

string

startDate

string

endDate

string

Responses

application/json

CalculatedChurn

Collection of series of a vendor's calculated sale metrics

GET/vendors/{vendorId}/reporting/sales/metrics/churn
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/metrics/churn' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "total": { "name": "<string>", "datasets": [ { "name": "<string>", "series": [ { "name": "<string>", "uniqueTotal": 34, "elements": [ { "date": "<string>", "count": 66 } ] } ] } ] }, "addons": [ { "addonKey": "<string>", "name": "<string>", "datasets": [ { "name": "<string>", "series": [ { "name": "<string>", "uniqueTotal": 34, "elements": [ { "date": "<string>", "count": 66 } ] } ] } ] } ] }
GET

Get Cloud conversions

Get a list of Cloud conversion events for the specified vendor's apps. For a given period, conversions are calculated as the number of evaluation licenses that converted into paid licenses. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

aggregation

string

startDate

string

endDate

string

Responses

application/json

CalculatedConversions

Collection of series of a vendor's calculated sale metrics

GET/vendors/{vendorId}/reporting/sales/metrics/conversion
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/metrics/conversion' \ --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": 66 } ] } ] }, "addons": [ { "addonKey": "<string>", "name": "<string>", "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 66 } ] } ] } ] }
GET

Get Cloud renewals

Get a list of Cloud renewal events for the specified vendor's apps. For a given period, renewals are calculated as the number of paying customers that have an opportunity to renew and choose to continue paying. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

aggregation

string

startDate

string

endDate

string

Responses

application/json

CalculatedRenewals

Collection of series of a vendor's calculated sale metrics

GET/vendors/{vendorId}/reporting/sales/metrics/renewal
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/metrics/renewal' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "total": { "name": "<string>", "datasets": [ { "name": "<string>", "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 66 } ] } ] } ] }, "addons": [ { "addonKey": "<string>", "name": "<string>", "datasets": [ { "name": "<string>", "series": [ { "name": "<string>", "elements": [ { "date": "<string>", "count": 66 } ] } ] } ] } ] }
GET

Get Cloud license events

Get the details about an individual Cloud license event (churn, conversion or renewal) for a specific vendor's apps.

This resource requires authentication.

Request

Path parameters

vendorId

integer

Required
saleMetric

string

Required

Query parameters

addon

array<string>

hosting

array<string>

lastUpdated

string

partnerType

array<string>

text

string

startDate

string

endDate

string

sortBy

string

order

string

Responses

application/json

LicenseTransitionCollection

Collection of a vendor's license conversions, churn, or renewal events

GET/vendors/{vendorId}/reporting/sales/metrics/{saleMetric}/details
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/metrics/{saleMetric}/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 45 46 47 48 49 50 { "_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>" } }, "events": [ { "addonKey": "<string>", "addonName": "<string>", "hosting": "<string>", "lastUpdated": "<string>", "eventDate": "<string>", "transactionId": "<string>", "licenseDetails": { "licenseId": "<string>", "appEntitlementId": "<string>", "appEntitlementNumber": "<string>", "cloudId": "<string>", "maintenanceStartDate": "<string>", "maintenanceEndDate": "<string>", "monthsValid": 51 } } ] }
GET

Export Cloud license events

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

Request

Path parameters

vendorId

integer

Required
saleMetric

string

Required

Query parameters

addon

array<string>

hosting

array<string>

lastUpdated

string

partnerType

array<string>

text

string

startDate

string

endDate

string

sortBy

string

order

string

accept

string

Responses

This status code has no content.

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

Get transactions

Get a list of transactions 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>

saleType

array<string>

partnerType

array<string>

hosting

array<string>

lastUpdated

string

excludeZeroTransactions

boolean

Responses

application/json

TransactionCollection

Collection of transactions for the vendor's apps

GET/vendors/{vendorId}/reporting/sales/transactions
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/transactions' \ --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 { "_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>" } }, "transactions": [ { "transactionId": "<string>", "addonLicenseId": "<string>", "appEntitlementId": "<string>", "appEntitlementNumber": "<string>", "hostLicenseId": "<string>", "hostEntitlementId": "<string>", "hostEntitlementNumber": "<string>", "licenseId": "<string>", "addonKey": "<string>", "addonName": "<string>", "lastUpdated": "<string>", "cloudId": "<string>", "paymentStatus": "Paid", "dunningStatus": [ { "attemptCount": 64, "paymentAttemptDate": "<string>" } ], "customerDetails": { "company": "<string>", "country": "<string>", "region": "<string>", "technicalContact": {}, "billingContact": {} }, "purchaseDetails": { "saleDate": "<string>", "licenseType": "ACADEMIC", "hosting": "Server", "billingPeriod": "Monthly", "changeInBillingPeriod": "Yes", "oldBillingPeriod": "Monthly", "tier": "<string>", "changeInTier": "Increase", "oldTier": "<string>", "parentProductName": "Jira", "parentProductEdition": "Jira", "changeInParentProductEdition": "Yes", "oldParentProductEdition": "<string>", "purchasePrice": 40, "vendorAmount": 88, "partnerDiscountAmount": 63, "discounts": [ { "type": "LOYALTY_DISCOUNT", "amount": 46 } ], "refundReason": "<string>", "creditNoteReason": "<string>", "saleType": "New", "maintenanceStartDate": "<string>", "maintenanceEndDate": "<string>", "paymentTerms": "Net14", "originalTransactionDetails": {} }, "partnerDetails": { "partnerName": "<string>", "partnerType": "Expert", "billingContact": {} } } ] }
GET

Export transactions

Export all transactions, 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>

saleType

array<string>

partnerType

array<string>

hosting

array<string>

lastUpdated

string

excludeZeroTransactions

boolean

Responses

Content downloaded will be the csv/json file

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

Initiate Async Export transactions

Initiate a POST request to export all transactions 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>

saleType

array<string>

partnerType

array<string>

hosting

array<string>

lastUpdated

string

excludeZeroTransactions

boolean

Responses

application/json

InitiateAsyncTransactionCollection

Initiate licenses export request for the vendor's apps

POST/vendors/{vendorId}/reporting/sales/transactions/async/export
1 2 3 4 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/transactions/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 transactions

Get status for async export transaction request

Request

Path parameters

vendorId

integer

Required
exportId

string

Required

Responses

application/json

StatusAsyncTransactionCollection

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

GET/vendors/{vendorId}/reporting/sales/transactions/async/export/{exportId}/status
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/transactions/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 transactions

Download async export transactions

Request

Path parameters

vendorId

integer

Required
exportId

string

Required

Responses

Content downloaded will be the csv/json file

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

Get aggregated sales

Get aggregated sales for the specified vendor, aggregated by the specified metric. Sales 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/sales/transactions/{metric}
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/transactions/{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

Export free starter tier entitlements

Export entitlements under free starter tier plan, 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>

includeAtlassianLicenses

boolean

date

string

accept

string

Responses

This status code has no content.

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

Get Cloud churn benchmark

Get cloud churn benchmark for the specified vendor's apps. This feature enables to have a deeper understanding of cloud churn numbers and allows to compare app performance to all other cloud apps on Marketplace. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

addon

string

startDate

string

endDate

string

Responses

application/json

ChurnBenchmark

Cloud churn benchmark events for vendor’s apps.

GET/vendors/{vendorId}/reporting/sales/metrics/churn/benchmark
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/sales/metrics/churn/benchmark' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "churnBenchmarkPerApp": { "appName": "Insight - Asset Management", "appKey": "com.riadalabs.jira.plugins.insight", "churnBenchmarkPerMonth": [ { "year": "2021", "month": "11", "totalLicenses": 100, "churnedLicenses": 12, "churnRate": 12, "isolatedChurnRate": 8, "churnRateBenchmark": 20, "isolatedChurnRateBenchmark": 5 } ] } }
GET

Get Cloud evaluation benchmark

To fetch count of evaluations and benchmark. This resource returns monthly and year-to-date count of evaluations, and their Month over Month and Year over Year growth respectively. It also returns benchmarks for the growth figures by comparing them against overall Marketplace growth.

This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

addon

array<string>

startDate

string

endDate

string

Responses

application/json

CloudEvaluationBenchmarkCollection

Collection of cloud evaluation benchmark for the partner's apps

GET/vendors/{vendorId}/reporting/benchmark/evaluations
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/benchmark/evaluations' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "totals": { "name": "<string>", "CloudEvaluationBenchmarkPerVendorPerMonth": [ { "date": "2022-01-01T00:00:00.000Z", "evalautionCount": 20, "previousMonthEvaluationCounts": 15, "evaluationMoMGrowth": 30.5, "evaluationPercentile": 50.5, "evaluationMoMGrowthBenchmarkAllPartners": 26.87, "evaluationCountYTD": 29, "evaluationCountYTDLastYear": 24, "evaluationYTDYoYGrowth": 10.7, "evaluationYTDPercentile": 57, "evaluationYTDYoYGrowthBenchmarkAllPartners": 8.2 } ] }, "CloudEvaluationBenchmarkPerApp": [ { "addonKey": "<string>", "name": "<string>", "CloudEvaluationBenchmarkPerAppPerMonth": [ { "date": "2022-01-01T00:00:00.000Z", "evalautionCount": 20, "previousMonthEvaluationCounts": 15, "evaluationMoMGrowth": 30.5, "evaluationPercentile": 50.5, "evaluationMoMGrowthBenchmarkAllAppsOnBaseProduct": 26.87, "evaluationCountYTD": 29, "evaluationCountYTDLastYear": 24, "evaluationYTDYoYGrowth": 10.7, "evaluationYTDPercentile": 57, "evaluationYTDYoYGrowthBenchmarkAllAppsOnBaseProduct": 8.2 } ] } ] }
GET

Get Cloud sales benchmark

To fetch cloud sales and benchmark for the specified partner and partner's apps. It includes only partner share of sales and does not include Atlassian share. This resource returns monthly and year-to-date sales value from marketplace transactions, and their Month over Month and Year over Year growth respectively. It also returns benchmarks for the growth figures by comparing them against overall Marketplace growth and base product growth.

This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

addon

array<string>

startDate

string

endDate

string

Responses

application/json

CloudSalesBenchmark

Collection of sales benchmark for partner

GET/vendors/{vendorId}/reporting/benchmark/sales
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/benchmark/sales' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "total": { "name": "All apps", "salesBenchmarkPerMonth": [ { "date": "2022-12-01T00:00:00.000Z", "sale": 2000, "previousMonthSale": 2000, "salesMoMGrowth": 33.33, "salesPercentile": 12, "salesMoMGrowthBenchmarkAllPartners": 8.33, "salesYTD": 17000, "salesYTDLastYear": 14000, "salesYTDYoYGrowth": 21.43, "salesYTDPercentile": 20, "salesYTDYoYGrowthBenchmarkAllPartners": 14.77 } ] }, "addons": [ { "addonKey": "<string>", "name": "<string>", "salesBenchmarkPerMonth": [ { "date": "2022-12-01T00:00:00.000Z", "sale": 2000, "previousMonthSale": 1900, "salesMoMGrowth": 33.33, "salesPercentile": 20, "salesMoMGrowthBenchmarkAllAppsOnBaseProduct": -5, "salesMoMGrowthBenchmarkBaseProduct": 33.33, "salesYTD": 17000, "salesYTDLastYear": 14000, "salesYTDYoYGrowth": 21.43, "salesYTDPercentile": 20, "salesYTDYoYGrowthBenchmarkAllAppsOnBaseProduct": -7.22, "salesYTDYoYGrowthBenchmarkBaseProduct": 33.33 } ] } ] }
GET

Get Customer Insights (By Region)

To fetch count of customers split by region and percentage distribution of customers across regions (APAC, EMEA, Americas, Unknown). It also returns a benchmark of the percentage distribution by comparing it against overall Marketplace distribution.

This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

startDate

string

endDate

string

Responses

application/json

RegionWiseUserDistributionInsights

Region wise user distribution insights events for partner.

GET/vendors/{vendorId}/reporting/customer-insights/regions
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/customer-insights/regions' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "regionWiseUserInsightsPerMonth": [ { "date": "2021-01-01T00:00:00.000Z", "insightsType": [ { "value": { "group": { "edition": "premium", "region": "<string>", "activeUsers": "<string>", "product": "<string>", "tier": "<string>" }, "usersDistribution": { "usersCount": 900, "usersPercent": 20, "usersMarketplaceBenchmark": 1.2 } } } ] } ] }
GET

Get Customer Insights (By Edition)

To fetch count of customers split by parent product edition and percentage distribution of customers across parent product editions. It also returns a benchmark of the percentage distribution by comparing it against overall Marketplace distribution. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

startDate

string

endDate

string

Responses

application/json

UsersEditionInsightsCollection

Edition wise user distribution insights events for partner.

GET/vendors/{vendorId}/reporting/customer-insights/editions
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/customer-insights/editions' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "usersEditionDistribution": [ { "date": "2021-01-01T00:00:00.000Z", "insightsType": [ { "value": { "group": { "edition": "premium", "region": "<string>", "activeUsers": "<string>", "product": "<string>", "tier": "<string>" }, "usersDistribution": { "usersCount": 900, "usersPercent": 20, "usersMarketplaceBenchmark": 1.2 } } } ] } ] }
GET

Get Customer Insights (By ActiveUsers)

To fetch count of customers using a paid instance of Jira or Confluence and the count as a percentage of total customers. It also returns a benchmark of the percentage value by comparing it against overall Marketplace average. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

startDate

string

endDate

string

Responses

application/json

ActivePaidUsersBenchmark

Active paid and non-paid users of the partner benchmarked against all Marketplace partners

GET/vendors/{vendorId}/reporting/customer-insights/active-users
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/customer-insights/active-users' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "activePaidUsersInsights": [ { "date": "2021-01-01T00:00:00.000Z", "insightsType": [ { "value": { "group": { "edition": "premium", "region": "<string>", "activeUsers": "<string>", "product": "<string>", "tier": "<string>" }, "usersDistribution": { "usersCount": 900, "usersPercent": 20, "usersMarketplaceBenchmark": 1.2 } } } ] } ] }
GET

Get Customer Insights (By Tier)

To fetch count of customers split by user tier and percentage distribution of customers across user tiers. User tier indicates the count of users on Jira or Confluence instance (1 to 10, 11 to 100, 101 to 1000, etc.). It also returns a benchmark of the percentage distribution by comparing it against overall Marketplace distribution.

This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

startDate

string

endDate

string

product

string

Responses

application/json

TierWiseUserBenchmark

Total users of the partner by user tier, split by parent product type

GET/vendors/{vendorId}/reporting/customer-insights/tiers
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/customer-insights/tiers' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "usersDistributionPerProduct": [ { "date": "2021-01-01T00:00:00.000Z", "insightsType": [ { "value": { "group": { "edition": "premium", "region": "<string>", "activeUsers": "<string>", "product": "<string>", "tier": "<string>" }, "usersDistribution": { "usersCount": 900, "usersPercent": 20, "usersMarketplaceBenchmark": 1.2 } } } ] } ] }
GET

Get Top Search Keywords (By source)

Get the list of top 500 searched keywords on the basis of source type. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required
sourceKey

string

Required

Query parameters

startDate

string

endDate

string

Responses

application/json

SearchKeywordsBySource

Collection of top searched keywords on the basis of source type.

GET/vendors/{vendorId}/reporting/search-keywords/source/{sourceKey}
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/search-keywords/source/{sourceKey}' \ --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": { "template": "<string>", "type": "<string>", "name": "<string>" }, "export": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ] }, "details": [ { "searchKeyword": "project", "percentage": 10 } ] }
GET

Export Top Search Keywords (By source)

Export the list of top 500 searched keywords on the basis of source type. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required
sourceKey

string

Required

Query parameters

startDate

string

endDate

string

accept

string

Responses

This status code has no content.

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

Get Zero Search Results Keywords

Get zero search results keywords on the basis of source type. This feature will help to have deeper understanding of searched keywords that have zero search results and thereby discover the opportunity to build apps. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required
sourceKey

string

Required

Query parameters

startDate

string

endDate

string

Responses

application/json

ZeroSearchResultsKeywords

Collection of zero search results keywords

GET/vendors/{vendorId}/reporting/zero-search-results-keywords/source/{sourceKey}
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/zero-search-results-keywords/source/{sourceKey}' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" }, "export": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ] }, "details": { "searchKeyword": "Project", "productFilter": "jira", "hostingFilter": "server", "categoryFilter": "Utilities", "otherFilter": "Beta", "count": 33 } }
GET

Export Zero Search Results Keywords

Export zero search results keywords on the basis of source type. This feature will help to have deeper understanding of searched keywords that have zero search results and thereby discover the opportunity to build apps. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required
sourceKey

string

Required

Query parameters

startDate

string

endDate

string

accept

string

Responses

This status code has no content.

GET/vendors/{vendorId}/reporting/zero-search-results-keywords/source/{sourceKey}/export
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/zero-search-results-keywords/source/{sourceKey}/export' \ --user 'email@example.com:<api_token>'
GET

Get Search Keywords (By Partner)

Get aggregated searched keywords detail which includes top search keyword and total search appearances for all the apps from the specified partner. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

startDate

string

endDate

string

aggregation

string

Responses

application/json

SearchKeywordsByPartner

Collection of aggregated searched keywords for all the apps from that specific partner.

GET/vendors/{vendorId}/reporting/search-keywords
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/search-keywords' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" }, "export": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ] }, "total": { "searchAppearances": 100, "topSearchKeyword": "project" }, "addons": [ { "addonName": "<string>", "addOnKey": "<string>", "leadingSearchKeyword": "<string>", "searchAppearances": 74, "elements": [ { "date": "<string>", "count": 49 } ] } ] }
GET

Export Search Keywords (By Partner)

Export aggregated searched keywords detail which includes top search keyword and total search appearances for all the apps from the specified partner. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

startDate

string

endDate

string

aggregation

string

accept

string

Responses

This status code has no content.

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

Get Search Keywords (By App)

Fetch the details of searched keywords for which the particular app showed up. It also populates the leading searched keywords based on the number of counts that resulted in showing the app. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required
addonKey

string

Required

Query parameters

startDate

string

endDate

string

aggregation

string

Responses

application/json

SearchKeywordsByApp

Collection of searched keywords by app

GET/vendors/{vendorId}/addons/{addonKey}/reporting/search-keywords
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/addons/{addonKey}/reporting/search-keywords' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" }, "export": [ { "href": "<string>", "type": "<string>", "title": "<string>" } ] }, "summary": { "addonName": "Insight - Asset Management", "addonKey": "com.riadalabs.jira.plugins.insight", "leadingSearchKeyword": "Server", "allSearchAppearances": 33 }, "details": [ { "searchKeyword": "Project", "hostingFilter": "Jira", "keywordCount": 33, "elements": [ { "date": "1927-09-12T00:00:00.000Z", "count": 33 } ] } ] }
GET

Export Search Keywords (By App)

Export the list of searched keywords for which the particular app showed up. It also populates the leading searched keywords based on the number of counts that resulted in showing the app. This resource requires authentication.

Request

Path parameters

vendorId

integer

Required
addonKey

string

Required

Query parameters

startDate

string

endDate

string

aggregation

string

accept

string

Responses

This status code has no content.

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

Get App requests and approvals

To fetch count of app install requests sent by end-users to admins, count of approvals and approval rate.

This resource requires authentication.

Request

Path parameters

vendorId

integer

Required

Query parameters

addon

array<string>

startDate

string

endDate

string

Responses

application/json

AppRequestsAndApprovals
GET/vendors/{vendorId}/reporting/app-requests-and-approvals
1 2 3 4 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/app-requests-and-approvals' \ --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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "query": { "template": "<string>", "type": "<string>", "name": "<string>" } }, "total": { "name": "All apps", "appRequestsAndApprovalsPerMonth": [ { "date": "2022-06-01T00:00:00.000Z", "appRequests": 30, "appRequestsApproved": 17, "appRequestsApprovalRate": 56.66 } ] }, "addons": [ { "addonKey": "appKey", "name": "app1", "appRequestsAndApprovalsPerAppPerMonth": [ { "date": "2022-06-01T00:00:00.000Z", "appRequests": 50, "appRequestsApproved": 20, "appRequestsApprovalRate": 40 } ] } ] }
POST

Fetch metric time series

This resource fetches the time series data for the metric of choice. It requires authentication and is currently available as part of EAP.

Request

Path parameters

vendorId

integer

Required

Request bodyapplication/json

attributes

array<object>

metrics

ReportingMetricTimeSeriesRequestMetrics

dateRange

ReportingMetricTimeSeriesRequestDateRange

granularity

string

attributeFilter

object

Responses

The service returns a successful response with the required metrics. There are no validation errors or authentication/authorization errors.

application/json

ReportingMetricTimeSeriesResponseBody
POST/vendors/{vendorId}/partner-metrics
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 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/partner-metrics' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "dateRange": { "startDate": "2022-03-01", "endDate": "2022-05-31" }, "attributes": [ { "name": "APP_KEY" }, { "name": "APP_NAME" }, { "name": "GRACE_PERIOD_IN_DAYS" }, { "name": "SUBSCRIPTION" } ], "metrics": { "metricSets": [ { "name": "RECURRING_REVENUE" } ], "metricFields": [ { "name": "OPENING_MRR" }, { "name": "CLOSING_MRR" } ] }, "attributesFilter": { "expr": { "andGroup": [ { "filter": { "fieldName": "APP_KEY", "oneFilter": { "stringFilter": { "value": "org.sample-org.sample-app" } } } }, { "filter": { "fieldName": "GRACE_PERIOD_IN_DAYS", "oneFilter": { "stringFilter": { "value": "14" } } } }, { "filter": { "fieldName": "SUBSCRIPTION", "oneFilter": { "stringFilter": { "value": "MONTHLY" } } } } ] } } }'
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 { "records": [ { "date": "2022-05-31", "appName": "Sample app - Issue Tracking", "appKey": "org.sample-org.sample-app", "gracePeriodInDays": "14", "subscription": "MONTHLY", "openingMrr": 1460583.83, "newMrr": 70992.51, "expiredMrr": -124783.04, "reactivatedMrr": 70411.32, "expansionMrr": 181590.35, "contractionMrr": -64881.69, "closingMrr": 1464207.86 }, { "date": "2022-04-30", "appName": "Sample app - Issue Tracking", "appKey": "org.sample-org.sample-app", "gracePeriodInDays": "14", "subscription": "MONTHLY", "openingMrr": 1435169.03, "newMrr": 66755.9, "expiredMrr": -101691.61, "reactivatedMrr": 58706.26, "expansionMrr": 107086.43, "contractionMrr": -66120.52, "closingMrr": 1460583.83 }, { "date": "2022-03-31", "appName": "Sample app - Issue Tracking", "appKey": "org.sample-org.sample-app", "gracePeriodInDays": "14", "subscription": "MONTHLY", "openingMrr": 1405839.25, "newMrr": 61906.32, "expiredMrr": -99821.2, "reactivatedMrr": 58159.81, "expansionMrr": 102494.66, "contractionMrr": -63709.51, "closingMrr": 1435169.03 } ] }

Rate this page: