Atlassian Marketplace Developer

Atlassian Marketplace Developer

Rate this page:

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

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'

Responses

Content typeValue
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

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'

Responses

Content typeValue
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

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

addon

Array<string>

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

hosting

Array<string>

Restricts the query to values for these hosting types

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

Format: int32

Example

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'

Responses

Content typeValue
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

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

addon

Array<string>

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

hosting

Array<string>

Restricts the query to values for these hosting types

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

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

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

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'

Responses

Content typeValue
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

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

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

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

partnerType

Array<string>

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

Valid values: direct, expert, reseller

hosting

Array<string>

Restricts the query to values for these hosting types

Valid values: cloud, datacenter, server

status

Array<string>

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

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(closed beta) and evaluation to sale insights(closed beta)

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

Format: int32

Example

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'

Responses

Content typeValue
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

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

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

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

partnerType

Array<string>

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

Valid values: direct, expert, reseller

hosting

Array<string>

Restricts the query to values for these hosting types

Valid values: cloud, datacenter, server

status

Array<string>

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

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(closed beta) and evaluation to sale insights(closed beta)

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

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

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

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'

Responses

Content typeValue
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

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'

Responses

Content typeValue
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

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'

Responses

Content typeValue
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

hosting

Array<string>

Restricts the query to values for these hosting types

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

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

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'

Responses

Content typeValue
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

hosting

Array<string>

Restricts the query to values for these hosting types

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

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

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

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

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

saleType

Array<string>

Restricts the query to sales of these types

Valid values: new, refund, renewal, upgrade

partnerType

Array<string>

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

Valid values: direct, expert, reseller

hosting

Array<string>

Restricts the query to values for these hosting types

Valid values: cloud, datacenter, server

lastUpdated

string

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

Format: date
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

Format: int32

Example

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'

Responses

Content typeValue
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

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

saleType

Array<string>

Restricts the query to sales of these types

Valid values: new, refund, renewal, upgrade

partnerType

Array<string>

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

Valid values: direct, expert, reseller

hosting

Array<string>

Restricts the query to values for these hosting types

Valid values: cloud, datacenter, server

lastUpdated

string

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

Format: date
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

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

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

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'

Responses

Content typeValue
application/json

AggregatedAddonsWithTotal

Rate this page: