Rate this page:
Information about vendor reporting
GET /rest/2/vendors/{vendorId}/reporting
Get links to permitted vendor reporting resources. This resource requires authentication.
integer
The unique identifier for this vendor
int64
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'
Content type | Value |
---|---|
application/json |
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.
integer
The unique identifier for this vendor
int64
string
The unique identifier for this evaluation metric
Valid values: country
, hosting
, partner
, region
string
The time aggregation
Valid values: month
, week
string
Starting date for the query
date
string
Ending date for the query
date
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'
Content type | Value |
---|---|
application/json |
GET /rest/2/vendors/{vendorId}/reporting/feedback/details
Get a list of feedback for the specified vendor's apps. This resource requires authentication.
integer
The unique identifier for this vendor
int64
Array<string>
Restrict feedback to the specified type
form
Valid values: disable
, uninstall
boolean
Restrict feedback to feedback that is either anonymous or by a known user
Array<string>
Restrict feedback to the specified reason
form
Array<string>
If specified, restricts the query to values for apps with the specified keys
form
Array<string>
Restricts the query to values for these hosting types
form
Valid values: cloud
, datacenter
, server
string
Starting date for the query
date
string
Ending date for the query
date
string
Text to search for in the reporter details (license id and email address) and the optional message
integer
If specified, skips ahead by this number of items
int32
integer
If specified, limits the result set to this number of items
int32
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'
Content type | Value |
---|---|
application/json |
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.
integer
The unique identifier for this vendor
int64
Array<string>
Restrict feedback to the specified type
form
Valid values: disable
, uninstall
boolean
Restrict feedback to feedback that is either anonymous or by a known user
Array<string>
Restrict feedback to the specified reason
form
Array<string>
If specified, restricts the query to values for apps with the specified keys
form
Array<string>
Restricts the query to values for these hosting types
form
string
Starting date for the query
date
string
Ending date for the query
date
string
Text to search for in the reporter details (license id and email address) and the optional message
string
Specifies the response format. If unspecified, the 'Accept' header will be used.
Valid values: csv
, json
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>'
A schema has not been defined for this response code.
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.
integer
The unique identifier for this vendor
int64
string
The unique identifier for this vendor feedback metric
Valid values: reason
, type
string
The time aggregation
Valid values: month
, week
string
Starting date for the query
date
string
Ending date for the query
date
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'
Content type | Value |
---|---|
application/json |
GET /rest/2/vendors/{vendorId}/reporting/licenses
Get a list of licenses for the specified vendor's apps. This resource requires authentication.
integer
The unique identifier for this vendor
int64
Array<string>
If specified, restricts the query to values for apps with the specified keys
form
string
Starting date for the query
date
string
Ending date for the query
date
string
Text to search for in license fields (license id, customer information and partner information)
Array<integer>
Restricts the query to values for these user/edition tiers
form
string
The date field against which filters will be applied
Valid values: end
, start
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
form
Valid values: academic
, commercial
, community
, demonstration
, evaluation
, open_source
, starter
Array<string>
Specifies whether to query only direct sales, expert sales, or reseller sales
form
Valid values: direct
, expert
, reseller
Array<string>
Restricts the query to values for these hosting types
form
Valid values: cloud
, datacenter
, server
Array<string>
If specified, restricts the query to values with the provided status
form
Valid values: active
, cancelled
, inactive
boolean
This field is deprecated. Please use withDataInsights to obtain additional data insights. If specified, retrieve marketing funnel attribution data
boolean
If specified, retrieve additional data insights - marketing funnel attribution, evaluation opportunity size and evaluation to sale insights
string
If specified, restricts the query to values updated on or after the specified date
date
string
If specified, determines the license sort order
Valid values: addonName
, company
, country
, endDate
, hosting
, licenseId
, licenseType
, partner
, region
, startDate
...(Show more)
string
Determines whether values are sorted in ascending or descending order
Valid values: asc
, desc
integer
If specified, skips ahead by this number of items
int32
integer
If specified, limits the result set to this number of items
int32
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'
Content type | Value |
---|---|
application/json |
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.
integer
The unique identifier for this vendor
int64
Array<string>
If specified, restricts the query to values for apps with the specified keys
form
string
Starting date for the query
date
string
Ending date for the query
date
string
Text to search for in license fields (license id, customer information and partner information)
Array<integer>
Restricts the query to values for these user/edition tiers
form
string
The date field against which filters will be applied
Valid values: end
, start
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
form
Valid values: academic
, commercial
, community
, demonstration
, evaluation
, open_source
, starter
Array<string>
Specifies whether to query only direct sales, expert sales, or reseller sales
form
Valid values: direct
, expert
, reseller
Array<string>
Restricts the query to values for these hosting types
form
Valid values: cloud
, datacenter
, server
Array<string>
If specified, restricts the query to values with the provided status
form
Valid values: active
, cancelled
, inactive
boolean
This field is deprecated. Please use withDataInsights to obtain additional data insights. If specified, retrieve marketing funnel attribution data
boolean
If specified, retrieve additional data insights - marketing funnel attribution, evaluation opportunity size and evaluation to sale insights
string
If specified, restricts the query to values updated on or after the specified date
date
string
If specified, determines the license sort order
Valid values: addonName
, company
, country
, endDate
, hosting
, licenseId
, licenseType
, partner
, region
, startDate
...(Show more)
string
Determines whether values are sorted in ascending or descending order
Valid values: asc
, desc
string
Specifies the response format. If unspecified, the 'Accept' header will be used.
Valid values: csv
, json
1 2 3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/licenses/export' \
--user 'email@example.com:<api_token>'
A schema has not been defined for this response code.
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.
integer
The unique identifier for this vendor
int64
string
The time aggregation
Valid values: month
, week
string
Starting date for the query
date
string
Ending date for the query
date
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'
Content type | Value |
---|---|
application/json |
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.
integer
The unique identifier for this vendor
int64
string
The time aggregation
Valid values: month
, week
string
Starting date for the query
date
string
Ending date for the query
date
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'
Content type | Value |
---|---|
application/json |
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.
integer
The unique identifier for this vendor
int64
string
The time aggregation
Valid values: month
, week
string
Starting date for the query
date
string
Ending date for the query
date
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'
Content type | Value |
---|---|
application/json |
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.
integer
The unique identifier for this vendor
int64
string
Valid values: churn
, conversion
, renewal
Array<string>
If specified, restricts the query to values for apps with the specified keys
form
Array<string>
Restricts the query to values for these hosting types
form
Valid values: cloud
, datacenter
, server
string
If specified, restricts the query to values updated on or after the specified date
date
Array<string>
Specifies whether to query only direct sales, expert sales, or reseller sales
form
Valid values: direct
, expert
, reseller
string
Text to search for (transaction id, license id, customer information and partner information)
string
Starting date for the query
date
string
Ending date for the query
date
string
If specified, determines the data sort order
Valid values: addonName
, date
, hosting
, licenseId
, transactionId
string
Determines whether values are sorted in ascending or descending order
Valid values: asc
, desc
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'
Content type | Value |
---|---|
application/json |
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.
integer
The unique identifier for this vendor
int64
string
Valid values: churn
, conversion
, renewal
Array<string>
If specified, restricts the query to values for apps with the specified keys
form
Array<string>
Restricts the query to values for these hosting types
form
Valid values: cloud
, datacenter
, server
string
If specified, restricts the query to values updated on or after the specified date
date
Array<string>
Specifies whether to query only direct sales, expert sales, or reseller sales
form
Valid values: direct
, expert
, reseller
string
Text to search for (transaction id, license id, customer information and partner information)
string
Starting date for the query
date
string
Ending date for the query
date
string
If specified, determines the data sort order
Valid values: addonName
, date
, hosting
, licenseId
, transactionId
string
Determines whether values are sorted in ascending or descending order
Valid values: asc
, desc
string
Specifies the response format. If unspecified, the 'Accept' header will be used.
Valid values: csv
, json
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>'
A schema has not been defined for this response code.
GET /rest/2/vendors/{vendorId}/reporting/sales/transactions
Get a list of transactions for the specified vendor's apps. This resource requires authentication.
integer
The unique identifier for this vendor
int64
Array<string>
If specified, restricts the query to values for apps with the specified keys
form
string
Starting date for the query
date
string
Ending date for the query
date
string
Text to search for in transaction fields (transaction id, license id, customer information and partner information)
Array<integer>
Restricts the query to values for these user/edition tiers
form
Array<string>
Restricts the query to sales of these types
form
Valid values: new
, refund
, renewal
, upgrade
Array<string>
Specifies whether to query only direct sales, expert sales, or reseller sales
form
Valid values: direct
, expert
, reseller
Array<string>
Restricts the query to values for these hosting types
form
Valid values: cloud
, datacenter
, server
string
If specified, restricts the query to values updated on or after the specified date
date
string
If specified, determines the transaction sort order
Valid values: addonName
, company
, country
, date
, hosting
, licenseId
, licenseType
, partner
, partnerType
, purchasePrice
...(Show more)
string
Determines whether values are sorted in ascending or descending order
Valid values: asc
, desc
integer
If specified, skips ahead by this number of items
int32
integer
If specified, limits the result set to this number of items
int32
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'
Content type | Value |
---|---|
application/json |
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.
integer
The unique identifier for this vendor
int64
Array<string>
If specified, restricts the query to values for apps with the specified keys
form
string
Starting date for the query
date
string
Ending date for the query
date
string
Text to search for in transaction fields (transaction id, license id, customer information and partner information)
Array<integer>
Restricts the query to values for these user/edition tiers
form
Array<string>
Restricts the query to sales of these types
form
Valid values: new
, refund
, renewal
, upgrade
Array<string>
Specifies whether to query only direct sales, expert sales, or reseller sales
form
Valid values: direct
, expert
, reseller
Array<string>
Restricts the query to values for these hosting types
form
Valid values: cloud
, datacenter
, server
string
If specified, restricts the query to values updated on or after the specified date
date
string
If specified, determines the transaction sort order
Valid values: addonName
, company
, country
, date
, hosting
, licenseId
, licenseType
, partner
, partnerType
, purchasePrice
...(Show more)
string
Determines whether values are sorted in ascending or descending order
Valid values: asc
, desc
string
Specifies the response format. If unspecified, the 'Accept' header will be used.
Valid values: csv
, json
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>'
A schema has not been defined for this response code.
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.
integer
The unique identifier for this vendor
int64
string
The unique identifier for this sale metric
Valid values: country
, hosting
, partner
, region
, tier
, type
string
The time aggregation
Valid values: month
, week
string
Starting date for the query
date
string
Ending date for the query
date
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'
Content type | Value |
---|---|
application/json |
Rate this page: