The Atlassian Marketplace REST API

Reporting

Information about vendor reporting

Get reporting links

GET /rest/2/vendors/{vendorId}/reporting

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

Request

Path parameters

vendorId Required

integer

The unique identifier for this vendor

Format: int64

Example

cURL

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

200

Content type	Value
application/json	VendorReporting

Get aggregated evaluations

GET /rest/2/vendors/{vendorId}/reporting/evaluations/{metric}

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 Required

integer

The unique identifier for this vendor

Format: int64

metric Required

string

The unique identifier for this evaluation metric

Valid values: country, hosting, partner, region

Query parameters

aggregation

string

The time aggregation

Valid values: month, week

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	AggregatedAddonsWithTotal

Get feedback

GET /rest/2/vendors/{vendorId}/reporting/feedback/details

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

Request

Path parameters

vendorId Required

integer

The unique identifier for this vendor

Format: int64

Query parameters

type

Array<string>

Restrict feedback to the specified type

Style: form

Valid values: disable, uninstall

anonymous

boolean

Restrict feedback to feedback that is either anonymous or by a known user

reason

Array<string>

Restrict feedback to the specified reason

Style: form

addon

Array<string>

If specified, restricts the query to values for apps with the specified keys

Style: form

hosting

Array<string>

Restricts the query to values for these hosting types

Style: form

Valid values: cloud, datacenter, server

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

text

string

Text to search for in the reporter details (license id and email address) and the optional message

offset

integer

If specified, skips ahead by this number of items

Format: int32

limit

integer

If specified, limits the result set to this number of items. Max limit is 50

Format: int32

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

400

404

Content type	Value
application/json	VendorFeedbackCollection

Export feedback

GET /rest/2/vendors/{vendorId}/reporting/feedback/details/export

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

Request

Path parameters

vendorId Required

integer

The unique identifier for this vendor

Format: int64

Query parameters

type

Array<string>

Restrict feedback to the specified type

Style: form

Valid values: disable, uninstall

anonymous

boolean

Restrict feedback to feedback that is either anonymous or by a known user

reason

Array<string>

Restrict feedback to the specified reason

Style: form

addon

Array<string>

If specified, restricts the query to values for apps with the specified keys

Style: form

hosting

Array<string>

Restricts the query to values for these hosting types

Style: form

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

text

string

Text to search for in the reporter details (license id and email address) and the optional message

accept

string

Specifies the response format. If unspecified, the 'Accept' header will be used.

Valid values: csv, json

Example

cURL

Node.js

Java

Python

PHP

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>'

Responses

200

A schema has not been defined for this response code.

Get aggregated feedback

GET /rest/2/vendors/{vendorId}/reporting/feedback/metrics/{metric}

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 Required

integer

The unique identifier for this vendor

Format: int64

metric Required

string

The unique identifier for this vendor feedback metric

Valid values: reason, type

Query parameters

aggregation

string

The time aggregation

Valid values: month, week

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

Content type	Value
application/json	AggregatedAddonsWithTotal

Get licenses

GET /rest/2/vendors/{vendorId}/reporting/licenses

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

Request

Path parameters

vendorId Required

integer

The unique identifier for this vendor

Format: int64

Query parameters

addon

Array<string>

If specified, restricts the query to values for apps with the specified keys

Style: form

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

text

string

Text to search for in license fields (license id, customer information and partner information)

tier

Array<integer>

Restricts the query to values for these user/edition tiers

Style: form

dateType

string

The date field against which filters will be applied

Valid values: end, start

licenseType

Array<string>

If specified, restricts the query to values with the provided license type; 'inactive' queries for expired licenses. Queries for 'starter' are deprecated; results may not be as expected

Style: form

Valid values: academic, commercial, community, demonstration, evaluation, open_source, starter, free

partnerType

Array<string>

Specifies whether to query only direct sales, expert sales, or reseller sales

Style: form

Valid values: direct, expert, reseller

hosting

Array<string>

Restricts the query to values for these hosting types

Style: form

Valid values: cloud, datacenter, server

status

Array<string>

If specified, restricts the query to values with the provided status

Style: form

Valid values: active, cancelled, inactive

withAttribution

boolean

This field is deprecated. Please use withDataInsights to obtain additional data insights. If specified, retrieve marketing funnel attribution data

withDataInsights

boolean

If specified, retrieve additional data insights - marketing funnel attribution, evaluation opportunity size and evaluation to sale insights

includeAtlassianLicenses

boolean

If true, include internal Atlassian licenses in the report

lastUpdated

string

If specified, restricts the query to values updated on or after the specified date

Format: date

sortBy

string

If specified, determines the license sort order

Valid values: addonName, company, country, endDate, hosting, licenseId, licenseType, partner, region, startDate ...(Show more)

order

string

Determines whether values are sorted in ascending or descending order

Valid values: asc, desc

offset

integer

If specified, skips ahead by this number of items

Format: int32

limit

integer

If specified, limits the result set to this number of items. Max limit is 50

Format: int32

Example

cURL

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/licenses' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

200

502

Content type	Value
application/json	LicenseCollection

Export licenses

GET /rest/2/vendors/{vendorId}/reporting/licenses/export

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

Request

Path parameters

vendorId Required

integer

The unique identifier for this vendor

Format: int64

Query parameters

addon

Array<string>

If specified, restricts the query to values for apps with the specified keys

Style: form

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

text

string

Text to search for in license fields (license id, customer information and partner information)

tier

Array<integer>

Restricts the query to values for these user/edition tiers

Style: form

dateType

string

The date field against which filters will be applied

Valid values: end, start

licenseType

Array<string>

If specified, restricts the query to values with the provided license type; 'inactive' queries for expired licenses. Queries for 'starter' are deprecated; results may not be as expected

Style: form

Valid values: academic, commercial, community, demonstration, evaluation, open_source, starter, free

partnerType

Array<string>

Specifies whether to query only direct sales, expert sales, or reseller sales

Style: form

Valid values: direct, expert, reseller

hosting

Array<string>

Restricts the query to values for these hosting types

Style: form

Valid values: cloud, datacenter, server

status

Array<string>

If specified, restricts the query to values with the provided status

Style: form

Valid values: active, cancelled, inactive

withAttribution

boolean

This field is deprecated. Please use withDataInsights to obtain additional data insights. If specified, retrieve marketing funnel attribution data

withDataInsights

boolean

If specified, retrieve additional data insights - marketing funnel attribution, evaluation opportunity size and evaluation to sale insights

includeAtlassianLicenses

boolean

If true, include internal Atlassian licenses in the report

lastUpdated

string

If specified, restricts the query to values updated on or after the specified date

Format: date

sortBy

string

If specified, determines the license sort order

Valid values: addonName, company, country, endDate, hosting, licenseId, licenseType, partner, region, startDate ...(Show more)

order

string

Determines whether values are sorted in ascending or descending order

Valid values: asc, desc

accept

string

Specifies the response format. If unspecified, the 'Accept' header will be used.

Valid values: csv, json

Example

cURL

Node.js

Java

Python

PHP

1
2
3

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

Responses

200

502

A schema has not been defined for this response code.

Get Cloud churn

GET /rest/2/vendors/{vendorId}/reporting/sales/metrics/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 Required

integer

The unique identifier for this vendor

Format: int64

Query parameters

aggregation

string

The time aggregation

Valid values: month, week

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	CalculatedChurn

Get Cloud conversions

GET /rest/2/vendors/{vendorId}/reporting/sales/metrics/conversion

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 Required

integer

The unique identifier for this vendor

Format: int64

Query parameters

aggregation

string

The time aggregation

Valid values: month, week

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	CalculatedConversions

Get Cloud renewals

GET /rest/2/vendors/{vendorId}/reporting/sales/metrics/renewal

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 Required

integer

The unique identifier for this vendor

Format: int64

Query parameters

aggregation

string

The time aggregation

Valid values: month, week

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	CalculatedRenewals

Get Cloud license events

GET /rest/2/vendors/{vendorId}/reporting/sales/metrics/{saleMetric}/details

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 Required

integer

The unique identifier for this vendor

Format: int64

saleMetric Required

string

Valid values: churn, conversion, renewal

Query parameters

addon

Array<string>

If specified, restricts the query to values for apps with the specified keys

Style: form

hosting

Array<string>

Restricts the query to values for these hosting types

Style: form

Valid values: cloud, datacenter, server

lastUpdated

string

If specified, restricts the query to values updated on or after the specified date

Format: date

partnerType

Array<string>

Specifies whether to query only direct sales, expert sales, or reseller sales

Style: form

Valid values: direct, expert, reseller

text

string

Text to search for (transaction id, license id, customer information and partner information)

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

sortBy

string

If specified, determines the data sort order

Valid values: addonName, date, hosting, licenseId, transactionId

order

string

Determines whether values are sorted in ascending or descending order

Valid values: asc, desc

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	LicenseTransitionCollection

Export Cloud license events

GET /rest/2/vendors/{vendorId}/reporting/sales/metrics/{saleMetric}/details/export

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

Request

Path parameters

vendorId Required

integer

The unique identifier for this vendor

Format: int64

saleMetric Required

string

Valid values: churn, conversion, renewal

Query parameters

addon

Array<string>

If specified, restricts the query to values for apps with the specified keys

Style: form

hosting

Array<string>

Restricts the query to values for these hosting types

Style: form

Valid values: cloud, datacenter, server

lastUpdated

string

If specified, restricts the query to values updated on or after the specified date

Format: date

partnerType

Array<string>

Specifies whether to query only direct sales, expert sales, or reseller sales

Style: form

Valid values: direct, expert, reseller

text

string

Text to search for (transaction id, license id, customer information and partner information)

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

sortBy

string

If specified, determines the data sort order

Valid values: addonName, date, hosting, licenseId, transactionId

order

string

Determines whether values are sorted in ascending or descending order

Valid values: asc, desc

accept

string

Specifies the response format. If unspecified, the 'Accept' header will be used.

Valid values: csv, json

Example

cURL

Node.js

Java

Python

PHP

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>'

Responses

200

502

A schema has not been defined for this response code.

Get transactions

GET /rest/2/vendors/{vendorId}/reporting/sales/transactions

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

Request

Path parameters

vendorId Required

integer

The unique identifier for this vendor

Format: int64

Query parameters

addon

Array<string>

If specified, restricts the query to values for apps with the specified keys

Style: form

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

text

string

Text to search for in transaction fields (transaction id, license id, customer information and partner information)

tier

Array<integer>

Restricts the query to values for these user/edition tiers

Style: form

saleType

Array<string>

Restricts the query to sales of these types

Style: form

Valid values: new, refund, renewal, upgrade

partnerType

Array<string>

Specifies whether to query only direct sales, expert sales, or reseller sales

Style: form

Valid values: direct, expert, reseller

hosting

Array<string>

Restricts the query to values for these hosting types

Style: form

Valid values: cloud, datacenter, server

lastUpdated

string

If specified, restricts the query to values updated on or after the specified date

Format: date

excludeZeroTransactions

boolean

If set to true, exclude $0 transactions from reports

sortBy

string

If specified, determines the transaction sort order

Valid values: addonName, company, country, date, hosting, licenseId, licenseType, partner, partnerType, purchasePrice ...(Show more)

order

string

Determines whether values are sorted in ascending or descending order

Valid values: asc, desc

offset

integer

If specified, skips ahead by this number of items

Format: int32

limit

integer

If specified, limits the result set to this number of items. Max limit is 50

Format: int32

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	TransactionCollection

Export transactions

GET /rest/2/vendors/{vendorId}/reporting/sales/transactions/export

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

Request

Path parameters

vendorId Required

integer

The unique identifier for this vendor

Format: int64

Query parameters

addon

Array<string>

If specified, restricts the query to values for apps with the specified keys

Style: form

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

text

string

Text to search for in transaction fields (transaction id, license id, customer information and partner information)

tier

Array<integer>

Restricts the query to values for these user/edition tiers

Style: form

saleType

Array<string>

Restricts the query to sales of these types

Style: form

Valid values: new, refund, renewal, upgrade

partnerType

Array<string>

Specifies whether to query only direct sales, expert sales, or reseller sales

Style: form

Valid values: direct, expert, reseller

hosting

Array<string>

Restricts the query to values for these hosting types

Style: form

Valid values: cloud, datacenter, server

lastUpdated

string

If specified, restricts the query to values updated on or after the specified date

Format: date

excludeZeroTransactions

boolean

If set to true, exclude $0 transactions from reports

sortBy

string

If specified, determines the transaction sort order

Valid values: addonName, company, country, date, hosting, licenseId, licenseType, partner, partnerType, purchasePrice ...(Show more)

order

string

Determines whether values are sorted in ascending or descending order

Valid values: asc, desc

accept

string

Specifies the response format. If unspecified, the 'Accept' header will be used.

Valid values: csv, json

Example

cURL

Node.js

Java

Python

PHP

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>'

Responses

200

502

A schema has not been defined for this response code.

Get aggregated sales

GET /rest/2/vendors/{vendorId}/reporting/sales/transactions/{metric}

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 Required

integer

The unique identifier for this vendor

Format: int64

metric Required

string

The unique identifier for this sale metric

Valid values: country, hosting, partner, region, tier, type

Query parameters

aggregation

string

The time aggregation

Valid values: month, week

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	AggregatedAddonsWithTotal

Export free starter tier entitlements

GET /rest/2/vendors/{vendorId}/reporting/sales/freeStarterTier/export

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 Required

integer

The unique identifier for this vendor

Format: int64

Query parameters

addon

Array<string>

If specified, restricts the query to values for apps with the specified keys

Style: form

includeAtlassianLicenses

boolean

If true, include internal Atlassian licenses in the report

date

string

If specified, restricts the query to the entitlements of the specified date. If not specified, gives the entitlements for the last valid date

Format: date

accept

string

Specifies the response format. If unspecified, the 'Accept' header will be used.

Valid values: csv, json

Example

cURL

Node.js

Java

Python

PHP

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>'

Responses

200

502

A schema has not been defined for this response code.

Get Cloud churn benchmark

GET /rest/2/vendors/{vendorId}/reporting/sales/metrics/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 Required

integer

The unique identifier for this vendor

Format: int64

Query parameters

addon

string

The unique identifier for an app

startDate

string

Starting date for the query

Format: date

endDate

string

Ending date for the query

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	ChurnBenchmark

Get Cloud evaluation benchmark

GET /rest/2/vendors/{vendorId}/reporting/benchmark/evaluations

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 Required

integer

The unique identifier for this partner

Format: int64

Query parameters

addon

Array<string>

The unique identifier for an app

Style: form

startDate

string

Starting date for the query and should be in the format YYYY-MM-DD and startDate will always be the start of the month irrespective of the date you provide. For example: if startDate entered is 2022-01-22, it will reflect as 2022-01-01

Format: date

endDate

string

Ending date for the query and should be in the format YYYY-MM-DD and and endDate will always be the start of the month irrespective of the date you provide. For example: if endDate entered is 2022-01-22, it will reflect as 2022-01-01

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	CloudEvaluationBenchmarkCollection

Get Cloud sales benchmark

GET /rest/2/vendors/{vendorId}/reporting/benchmark/sales

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 Required

integer

The unique identifier for this partner

Format: int64

Query parameters

addon

Array<string>

If specified, restricts the query to values for apps with the specified keys

Style: form

startDate

string

Starting date for the query and should be in the format YYYY-MM-DD and startDate will always be the start of the month irrespective of the data you provide.

For example: If startDate entered is 2022-01-22, it will reflect as 2022-01-01

Format: date

endDate

string

Ending date for the query and should be in the format YYYY-MM-DD and endDate will always be the start of the month irrespective of the data you provide.

For example: If endDate entered is 2022-01-22, it will reflect as 2022-01-01

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	CloudSalesBenchmark

Get Customer Insights (By Region)

GET /rest/2/vendors/{vendorId}/reporting/customer-insights/regions

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 Required

integer

The unique identifier for this partner

Format: int64

Query parameters

startDate

string

Starting date for the query and should be in the format YYYY-MM-DD and startDate will always be the start of the month irrespective of the data you provide.

For example: If startDate entered is 2022-01-22, it will reflect as 2022-01-01

Format: date

endDate

string

Ending date for the query and should be in the format YYYY-MM-DD and endDate will always be the start of the month irrespective of the data you provide.

For example: If endDate entered is 2022-01-22, it will reflect as 2022-01-01

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	RegionWiseUserDistributionInsights

Get Customer Insights (By Edition)

GET /rest/2/vendors/{vendorId}/reporting/customer-insights/editions

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 Required

integer

The unique identifier for this partner

Format: int64

Query parameters

startDate

string

Starting date for the query and should be in the format YYYY-MM-DD and startDate will always be the start of the month irrespective of the data you provide. For example: if startDate entered is 2022-01-22, it will reflect as 2022-01-01

Format: date

endDate

string

Ending date for the query and should be in the format YYYY-MM-DD and endDate will always be the start of the month irrespective of the data you provide. For example: if endDate entered is 2022-01-22, it will reflect as 2022-01-01

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	UsersEditionInsightsCollection

Get Customer Insights (By ActiveUsers)

GET /rest/2/vendors/{vendorId}/reporting/customer-insights/active-users

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 Required

integer

The unique identifier for this partner.

Format: int64

Query parameters

startDate

string

Starting date for the query. Should be in the format YYYY-MM-DD. startDate will always be the start of the month irrespective of the data you provide. For example: if startDate entered is 2022-01-22, it will reflect as 2022-01-01.

Format: date

endDate

string

Ending date for the query. Should be of the format YYYY-MM-DD. endDate will always be the start of the month irrespective of the data you provide. For example: if endDate entered is 2022-01-22, it will reflect as 2022-01-01

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	ActivePaidUsersBenchmark

Get Customer Insights (By Tier)

GET /rest/2/vendors/{vendorId}/reporting/customer-insights/tiers

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 Required

integer

The unique identifier for this partner.

Format: int64

Query parameters

startDate

string

Format: date

endDate

string

Format: date

product

string

Parent product type. For example: Jira or Confluence.

Example

cURL

Node.js

Java

Python

PHP

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'

Responses

200

502

Content type	Value
application/json	TierWiseUserBenchmark

Get Top Search Keywords (By source)

GET /rest/2/vendors/{vendorId}/reporting/search-keywords/source/{sourceKey}

Get the list of top 500 searched keywords on the basis of source type. This resource requires authentication. This resource is currently available as part of EAP.

Request

Path parameters

vendorId Required

integer

The unique identifier for this partner.

Format: int64

sourceKey Required

string

The unique identifier for the source type

Valid values: marketplace, embedded-marketplace

Query parameters

startDate

string

Starting date for the query. Should be in the format YYYY-MM-DD.

Format: date

endDate

string

Ending date for the query. Should be in the format YYYY-MM-DD.

Format: date

Example

cURL

Node.js

Java

Python

PHP

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'