Rate this page:

Reviews

Information about app reviews

Get app reviews

GET /rest/2/addons/{addonKey}/reviews

Get a list of reviews for the specified app.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Query parameters
sort

string

Specifies the review sort order

Valid values: helpful, recent

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
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

ReviewCollection

Create / update app review

POST /rest/2/addons/{addonKey}/reviews

Create or update a specific app review. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Body parameters
_links

ReviewLinks

_embedded

ReviewEmbedded

review

string

App review content

stars Required

integer

Number of stars

Format: int32

Example

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
curl --request POST \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "_links": {
    "self": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "alternate": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "author": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "response": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "flag": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "voteUp": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "voteDown": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    }
  },
  "_embedded": {
    "author": {
      "_links": {
        "alternate": {
          "href": "<string>"
        },
        "picture": {
          "href": "<string>"
        },
        "pictureTemplate": {
          "template": "<string>"
        }
      },
      "name": "<string>",
      "email": "<string>"
    },
    "response": {
      "_links": {
        "self": {
          "href": "<string>"
        }
      },
      "text": "<string>"
    }
  },
  "review": "<string>",
  "stars": 15
}'

Responses

Successfully modified

Header Parameters
Location

string

URI of the resource

Get app review

GET /rest/2/addons/{addonKey}/reviews/id/{reviewId}

Get a specific app review.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

reviewId Required

string

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

Review

Create / update app review

PUT /rest/2/addons/{addonKey}/reviews/id/{reviewId}

Create or update a specific app review.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

reviewId Required

string

Body parameters
_links

ReviewLinks

_embedded

ReviewEmbedded

review

string

App review content

stars Required

integer

Number of stars

Format: int32

Example

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
curl --request PUT \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}' \
  --header 'Content-Type: application/json' \
  --data '{
  "_links": {
    "self": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "alternate": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "author": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "response": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "flag": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "voteUp": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "voteDown": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    }
  },
  "_embedded": {
    "author": {
      "_links": {
        "alternate": {
          "href": "<string>"
        },
        "picture": {
          "href": "<string>"
        },
        "pictureTemplate": {
          "template": "<string>"
        }
      },
      "name": "<string>",
      "email": "<string>"
    },
    "response": {
      "_links": {
        "self": {
          "href": "<string>"
        }
      },
      "text": "<string>"
    }
  },
  "review": "<string>",
  "stars": 15
}'

Responses

Successfully modified

Header Parameters
Location

string

URI of the resource

Delete app review

DELETE /rest/2/addons/{addonKey}/reviews/id/{reviewId}

Delete a specific app review.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

reviewId Required

string

Example

1
2
curl --request DELETE \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}'

Responses

Success

Get app review downvote

GET /rest/2/addons/{addonKey}/reviews/id/{reviewId}/down

Returns whether or not the current user has downvoted the specified app review. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

reviewId Required

string

Example

1
2
3
4
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/down' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

BooleanState

Update app review downvote

PUT /rest/2/addons/{addonKey}/reviews/id/{reviewId}/down

Updates whether or not the current user has downvoted the specified app review. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

reviewId Required

string

Body parameters
_links

BooleanStateRepLinks

state Required

boolean

The true/false value of the state - its meaning depends on the resource

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request PUT \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/down' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "_links": {
    "self": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "up": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    }
  },
  "state": true
}'

Responses

Successfully modified

Header Parameters
Location

string

URI of the resource

Get app review flag

GET /rest/2/addons/{addonKey}/reviews/id/{reviewId}/flag

Returns whether or not the current user has flagged the specified app review. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

reviewId Required

string

Example

1
2
3
4
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/flag' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

BooleanState

Update app review flag

PUT /rest/2/addons/{addonKey}/reviews/id/{reviewId}/flag

Updates whether or not the current user has flagged the specified app review. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

reviewId Required

string

Body parameters
_links

BooleanStateRepLinks

state Required

boolean

The true/false value of the state - its meaning depends on the resource

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request PUT \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/flag' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "_links": {
    "self": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "up": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    }
  },
  "state": true
}'

Responses

Successfully modified

Header Parameters
Location

string

URI of the resource

Get app review response

GET /rest/2/addons/{addonKey}/reviews/id/{reviewId}/response

Get the response for the specified app review.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

reviewId Required

string

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/response' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

ReviewResponse

Create / update app review response

PUT /rest/2/addons/{addonKey}/reviews/id/{reviewId}/response

Create or update a specific app review response. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

reviewId Required

string

Body parameters
_links

SelfLinkOnly

text Required

string

Text of the response to the review

Format: html

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl --request PUT \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/response' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "_links": {
    "self": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    }
  },
  "text": "<string>"
}'

Responses

Successfully modified

Header Parameters
Location

string

URI of the resource

Delete app review response

DELETE /rest/2/addons/{addonKey}/reviews/id/{reviewId}/response

Delete a specific app review response. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

reviewId Required

string

Example

1
2
3
curl --request DELETE \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/response' \
  --user 'email@example.com:<api_token>'

Responses

Success

Get app review upvote

GET /rest/2/addons/{addonKey}/reviews/id/{reviewId}/up

Returns whether or not the current user has upvoted the specified app review. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

reviewId Required

string

Example

1
2
3
4
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/up' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

BooleanState

Update app review upvote

PUT /rest/2/addons/{addonKey}/reviews/id/{reviewId}/up

Updates whether or not the current user has upvoted the specified app review. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

reviewId Required

string

Body parameters
_links

BooleanStateRepLinks

state Required

boolean

The true/false value of the state - its meaning depends on the resource

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request PUT \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/id/{reviewId}/up' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "_links": {
    "self": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "up": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    }
  },
  "state": true
}'

Responses

Successfully modified

Header Parameters
Location

string

URI of the resource

Get my app review

GET /rest/2/addons/{addonKey}/reviews/mine

Get a specific app review written by the current user. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

1
2
3
4
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/mine' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

Review

Create / update my app review

PUT /rest/2/addons/{addonKey}/reviews/mine

Create or update a specific app review written by the current user. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Body parameters
_links

ReviewLinks

_embedded

ReviewEmbedded

review

string

App review content

stars Required

integer

Number of stars

Format: int32

Example

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
curl --request PUT \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/mine' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "_links": {
    "self": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "alternate": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "author": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "response": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "flag": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "voteUp": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    },
    "voteDown": {
      "href": "<string>",
      "type": "<string>",
      "title": "<string>"
    }
  },
  "_embedded": {
    "author": {
      "_links": {
        "alternate": {
          "href": "<string>"
        },
        "picture": {
          "href": "<string>"
        },
        "pictureTemplate": {
          "template": "<string>"
        }
      },
      "name": "<string>",
      "email": "<string>"
    },
    "response": {
      "_links": {
        "self": {
          "href": "<string>"
        }
      },
      "text": "<string>"
    }
  },
  "review": "<string>",
  "stars": 15
}'

Responses

Successfully modified

Header Parameters
Location

string

URI of the resource

Delete my app review

DELETE /rest/2/addons/{addonKey}/reviews/mine

Delete a specific app review written by the current user. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

1
2
3
curl --request DELETE \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/reviews/mine' \
  --user 'email@example.com:<api_token>'

Responses

Success

Rate this page: