# Resources

The API is organized around the following resources:

# Feedback posts

A feedback object represents an individual feedback post, submitted by or captured on behalf of an end user. You can list multiple posts or get a single post by its ID. It is also possible to create, update or remove prosts from your board.

GET /posts
POST /post
GET /post/:id
PUT /post/:id
DELETE /post/:id

# The post object

Attributes:

  • feedback_id:
  • product_id:
  • title:
  • description:
  • status:
  • type:
  • created:
  • updated:
  • user:
{
    "feedback_id": "3",
    "product_id": "1",
    "title": "Show/search for similar ideas as you [...]",
    "description": "This can help us avoid users posting a [...]",
    "status": "open",
    "trend": "0",
    "type": "user-interface",
    "total_up": "9",
    "total_down": "0",
    "total_sum": "9",
    "total_comments": "0",
    "total_ratio": "9",
    "total_subscriber": "1",
    "scoring": "0.55",
    "effort": "1",
    "created": "2020-05-22 16:49:00",
    "updated": "2020-05-22 16:49:00",
    "user": {
        "user_id": "4",
        "admin_id": 0,
        "data_name": "lennishq",
        "data_mail": "",
        "data_img": "https://storage.sleekplan.com/..."
    }
}

# List posts

GET /posts

Returns a list of your feedback posts. The posts are returned sorted by creation date, with the most recent post appearing first.

Parameters:

  • type:
  • sort:
  • filter:
  • owner:
  • search:
  • segment:
  • page:
curl https://api.sleekplan.com/v1/posts
?type=all&sort=trend&filter=open&page=0 \
  -u 96323866321ab812adf3509b1b436af5dac2b9a47: \
  -G

Response

{
    "status": "success",
    "data": {
        "items": {
            "3": {
                "feedback_id": "3",
                "product_id": "1",
                "title": "Show/search for similar ideas as you [...]",
                "description": "This can help us avoid users posting a [...]",
                "status": "open",
                "trend": "0",
                "type": "user-interface",
                "total_up": "9",
                "total_down": "0",
                "total_sum": "9",
                "total_comments": "0",
                "total_ratio": "9",
                "total_subscriber": "1",
                "scoring": "0.55",
                "effort": "1",
                "created": "2020-05-22 16:49:00",
                "updated": "2020-05-22 16:49:00",
                "user": {
                    "user_id": "4",
                    "admin_id": 0,
                    "data_name": "lennishq",
                    "data_mail": "",
                    "data_img": "https://storage.sleekplan.com/..."
                }
            },
        }
    }
}

# Create a post

POST /post

Returns the feedback object if the creation succeeded. Returns an error if create parameters are invalid (e.g. missing post title).

Parameters:

  • title:
  • type:
  • description:
  • user:
curl https://api.sleekplan.com/v1/post

Response

{
    "status": "success",
    "data": {
    }
}

# Get a single post

GET /post/:id

Returns a single feedback object for a valid identifier.

curl https://api.sleekplan.com/v1/posts
?type=all&sort=trend&filter=open&page=0 \
  -u 96323866321ab812adf3509b1b436af5dac2b9a47: \
  -G

Response

{
    "status": "success",
    "data": {
    }
}

# Update a post

PUT /post/:id

Returns the feedback object if the update succeeded. Returns an error if update parameters are invalid (e.g. invalid type).

Parameters:

  • title:
  • type:
  • description:
curl https://api.sleekplan.com/v1/posts

Response

{
    "status": "success",
    "data": {
    }
}

# Delete a post

DELETE /post/:id

Returns a success message. If the customer ID does not exist, this call returns an error.

curl https://api.sleekplan.com/v1/posts

Response

{
    "status": "success",
    "data": {
    }
}

# Changelog updates

A changelog object represents an individual post on your changelog. You can list multiple posts or get a single post by its ID. It is also possible to create, update or remove prosts from your changelog.

GET /updates
POST /update
GET /update/:id
PUT /update/:id
DELETE /update/:id

# The changelog object

Attributes:

  • feedback_id: dsdfdsfsdfs
  • product_id:
{
    "feedback_id": "3",
    "product_id": "1",
    "title": "Show/search for similar ideas as you [...]",
    "description": "This can help us avoid users posting a [...]",
    "status": "open",
}

# List updates

GET /updates

...

Parameters:

  • type:
  • search:
  • page:
curl https://api.sleekplan.com/v1/posts
?type=all&sort=trend&filter=open&page=0 \
  -u 96323866321ab812adf3509b1b436af5dac2b9a47: \
  -G

Response

{
    "status": "success",
    "data": {

    }
}

# Create a new update

POST /update

...

Parameters:

  • title:
  • type:
  • description:
curl https://api.sleekplan.com/v1/post

Response

{
    "status": "success",
    "data": {
    }
}

# Get a single update

GET /update/:id

...

curl https://api.sleekplan.com/v1/posts
?type=all&sort=trend&filter=open&page=0 \
  -u 96323866321ab812adf3509b1b436af5dac2b9a47: \
  -G

Response

{
    "status": "success",
    "data": {
    }
}

# Edit an update

PUT /update/:id

...

Parameters:

  • title:
  • type:
  • description:
curl https://api.sleekplan.com/v1/posts

Response

{
    "status": "success",
    "data": {
    }
}

# Delete an update

DELETE /update/:id

...

curl https://api.sleekplan.com/v1/posts

Response

{
    "status": "success",
    "data": {
    }
}

# Comments

A comment object represents an individual comment on a feedback post. You can list multiple comments or get a single comment by its ID. It is also possible to create, update or remove prosts from a post. Each comment is always assigned to a individual feedback identifier.

GET /post/comments
POST /post/:id/comment
GET /post/:id/comment/:id
PUT /post/:id/comment/:id
DELETE /post/:id/comment/:id

# The comment object

Attributes:

  • feedback_id: dsdfdsfsdfs
  • product_id:
{
    "feedback_id": "3",
    "product_id": "1",
    "title": "Show/search for similar ideas as you [...]",
    "description": "This can help us avoid users posting a [...]",
    "status": "open",
}

# List comments for a post

GET /post/:id/comments/

...

Parameters:

  • type:
  • search:
  • page:
curl https://api.sleekplan.com/v1/posts
?type=all&sort=trend&filter=open&page=0 \
  -u 96323866321ab812adf3509b1b436af5dac2b9a47: \
  -G

Response

{
    "status": "success",
    "data": {

    }
}

# Create a new update

POST /update

...

Parameters:

  • title:
  • type:
  • description:
curl https://api.sleekplan.com/v1/post

Response

{
    "status": "success",
    "data": {
    }
}

# Get a single update

GET /update/:id

...

curl https://api.sleekplan.com/v1/posts
?type=all&sort=trend&filter=open&page=0 \
  -u 96323866321ab812adf3509b1b436af5dac2b9a47: \
  -G

Response

{
    "status": "success",
    "data": {
    }
}

# Edit an update

PUT /update/:id

...

Parameters:

  • title:
  • type:
  • description:
curl https://api.sleekplan.com/v1/posts

Response

{
    "status": "success",
    "data": {
    }
}

# Delete an update

DELETE /update/:id

...

curl https://api.sleekplan.com/v1/posts

Response

{
    "status": "success",
    "data": {
    }
}