Comments

Overview

Communication over the proofs is done via comments and replies function inside Proof Viewer tool. 


Field

Description

Read-only

id

Unique ID of a comment.

parent_comment_id

Either null or unique ID of the parent proof.

 

proof_id

Unique ID of a Proof

 

comment

Text of the comment.

'Some text'

 

sequence

Number of the comment/reply posted under the proof. The first digit represents comment number inside the proof and the second one is the reply number.

1 / 2.1  / 6.18

created-at

Date of the comment creation.

'2012-02-22T02:06:58.147Z'

reviewer

Author of the comment. Can be only set during comment creation.

 

{

reviewer_id: 'reviewer_id',

email: 'name@domain.com'

}

 

 

location

Location of the comment.

 

{

page: 1 / null,

start_time: 'hh:mm:ss:SSS' / null

}

 

likes

List of all reviewers who liked the comment

 

[

{

reviewer_id: 'reviewer_id',

email: 'name@domain.com'

}, ...

]

replies

empty array or

[

{

Comment object

}, ...

]

attachments

empty array or

[

{

file_name='fix.pdf',

download_path='https://...'

}, ...

]

 

deleted

false / true

private

false / true

markers

Detailed description in table below

 

 

Markers - detailed description

Field

Decription

type

"rectangle' / "ellipse" / "arrow" / "line"

Default "rectangle"

color  color value in hex format
start_point

x and y start point coordinates in pixels

{

"x": 620,

"y": 514

},

end_point

x and y end point coordinates in pixels

{

"x": 837,

"y": 635

}

Get proof comments

Method Details
HTTP methods GET
Response format json
Requires authentication Yes
Rate limited Yes

GET /v1/proofs/{id}/comments

Returns list of all comments for a specific proof.

Required parameters How to use Description
API Token apikey=[key] query parameter Used to authenticate the request
Proof ID Used in the request URL (see above) Unique identifier of a specific proof version
Sample GET comments response
[
{
"id": "d53bd954-3189-4a5f-909e-4d42ee7b27f5",
"parent_comment_id": null,
"proof_id": "1783d827-0f06-403d-8932-375b9dbc474d",
"comment": "Comment 1",
"sequence": 1,
"created_at": "2018-06-08T14:00:17.591Z",
"reviewer": {
"reviewer_id": "07cbf998-2046-4633-8d0f-e0bf31dc3984",
"email": "name@domain.com"
},
"location": {
"page": 1,
"start_time": null
},
"likes": [
{
"reviewer_id": "07cbf998-2046-4633-8d0f-e0bf31dc3984",
"email": "user@domain.com"
}
],
"replies": [],
"attachments": [],
"deleted": false,
"private": false,
"markers": [
{
"type": "rectangle",
"color": "#9B59B6",
"start_point": {
"x": 620,
"y": 514
},
"end_point": {
"x": 837,
"y": 635
}
},
{
"type": "ellipse",
"color": "#9B59B6",
"start_point": {
"x": 652,
"y": 274
},
"end_point": {
"x": 848,
"y": 453
}
}
]
},
{
"id": "9aff5c8c-88f2-4b58-8471-38ed729bfae0",
"parent_comment_id": null,
"proof_id": "1783d827-0f06-403d-8932-375b9dbc474d",
"comment": "Comment 2 with reply",
"sequence": 2,
"created_at": "2018-06-08T14:02:30.658Z",
"reviewer": {
"reviewer_id": "07cbf998-2046-4633-8d0f-e0bf31dc3984",
"email": "name1@domain.com"
},
"location": {
"page": 1,
"start_time": null
},
"likes": [],
"replies": [
{
"id": "84c777a4-a9dd-4ff3-8050-7e05dabc3641",
"parent_comment_id": "9aff5c8c-88f2-4b58-8471-38ed729bfae0",
"proof_id": "1783d827-0f06-403d-8932-375b9dbc474d",
"comment": "reply with attachment to comment 2",
"sequence": 1,
"created_at": "2018-06-08T14:19:20.066Z",
"reviewer": {
"reviewer_id": "07cbf998-2046-4633-8d0f-e0bf31dc3984",
"email": "name4@domain.com"
},
"location": {
"page": 1,
"start_time": null
},
"likes": [],
"replies": [],
"attachments": [
{
"file_name": "somefile.png",
"download_path": "https://ziflow-s3.amazonaws.com/1783d827-0f06-403d-8932-375b9dbc474d/84c777a4-a9dd-4ff3-8050-7e05dabc3641/5b5e7833-58d6-4cde-b151-9de30517ea32/somefile.png"
}
],
"deleted": false,
"private": false,
"markers": []
}
],
"attachments": [],
"deleted": false,
"private": false,
"markers": [
{
"type": "arrow",
"color": "#9E78B6",
"start_point": {
"x": 620,
"y": 514
},
"end_point": {
"x": 837,
"y": 635
}
}
]
}

]

Create a comment/reply

Method Details
HTTP methods POST
Response format json
Requires authentication Yes
Rate limited Yes

POST v1/proofs/{id}/comments

A method used for adding comments or replies to a proof. 

If the reviewer field is provided make the comment or reply as them, otherwise make the comment as the person performing the API action:

Field Value
reviewer ID of the reviewer performing the action. Should be provided in the request body

 

 Required parameters  How to use  Description
API Token apikey=[key] query parameter Used to authenticate the request
Proof ID Used in the request URL  Unique identifier of a specific proof version
 comment Used in the request body  Comment text
 location Used in the request body  For static proof comment location should be a page. For audio/video it should be start_time. For Rich Media proof location is ignored.
Optional parameters  How to use  Description
 parent_comment_id Used in the request body  Comment added with the parent ID parameter is handled as a reply.

Like/Unlike comment

Method Details
HTTP methods POST
Response format json
Requires authentication Yes
Rate limited Yes

POST v1/proofs/{id}/comments/comment-id/like

API method to like or unlike a comment or reply.

If the 'reviewer_id' field is provided make like as them otherwise, like as the person performing the API action:

Field Value
reviewer_id ID of the reviewer performing the action. Should be provided in the request body
like Used in the request body

 

Returns the comment object