Rate this page:
Information about vendor reporting
Get links to permitted vendor reporting resources. This resource requires authentication.
integer
Required1
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'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 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
Requiredstring
Requiredstring
string
string
Collection of aggregated series of a vendor's sale data
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'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 a list of feedback for the specified vendor's apps. This resource requires authentication.
integer
Requiredarray<string>
boolean
array<string>
array<string>
array<string>
string
string
string
integer
integer
A collection of feedback received for the app
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'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>"
}
]
}Export all feedback, matching the specified filters, for the specified vendor's apps. This resource requires authentication.
integer
Requiredarray<string>
boolean
array<string>
array<string>
array<string>
string
string
string
string
This status code has no content.
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 aggregated feedback for the specified vendor, aggregated by the specified metric. Feedback can be aggregated by type and reason. This resource requires authentication.
integer
Requiredstring
Requiredstring
string
string
Collection of aggregated series of feedback data
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'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 a list of licenses for the specified vendor's apps. This resource requires authentication.
integer
Requiredarray<string>
string
string
string
array<integer>
string
array<string>
array<string>
array<string>
array<string>
Collection of licenses for the vendor's apps
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'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
{
"_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>",
"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>"
},
"evaluationOpportunitySize": "<string>",
"evaluationLicense": "<string>",
"daysToConvertEval": "<string>",
"evaluationStartDate": "<string>",
"evaluationEndDate": "<string>",
"evaluationSaleDate": "<string>",
"parentProductBillingCycle": "<string>",
"parentProductName": "<string>",
"parentProductEdition": "<string>",
"installedOnSandbox": "<string>"
}
]
}Export all licenses, matching the specified filters, for the specified vendor's apps. This resource requires authentication.
integer
Requiredarray<string>
string
string
string
array<integer>
string
array<string>
array<string>
array<string>
array<string>
Content downloaded will be the csv/json file
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/vendors/{vendorId}/reporting/licenses/export' \
--user 'email@example.com:<api_token>'Initiate a POST request to export all licenses that match the specified filters for the vendor's apps. This resource requires authentication.
integer
Requiredarray<string>
string
string
string
array<integer>
string
array<string>
array<string>
array<string>
array<string>
Initiate licenses export request for the vendor's apps
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'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 status for async export license request
integer
Requiredstring
RequiredGet Status for licenses export request for the vendor's apps
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'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"
}
}Download async export licenses
integer
Requiredstring
RequiredContent downloaded will be the csv/json file
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>'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
Requiredstring
string
string
Collection of series of a vendor's calculated sale metrics
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'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 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
Requiredstring
string
string