comments

The inbox: first-level comments across the whole organization

Served from PlanVortex's database, so it costs nothing and calls no social network. It is a snapshot: collected_date says when each row was last read. Open a thread to see what the network says right now.

Ordered by creation_date descending — the date on the network, not the date we collected it — so rows from ten networks interleave correctly.

On telegram the inbox starts the day the channel was connected. The Bot API has no way to read the past: a bot only learns what happens while it is inside, so nothing written before the connection exists here and never will. Say so in your UI — an inbox that opens empty on a busy channel reads like a failure.

Your own replies are not in here. Anything with author.is_own: true is filtered out: what you wrote is not incoming mail. They are still stored, and they do show up in the thread.

Requires the comments:read permission (client_organization_comments:read for apps) and a paid plan.

get/organizations/{id_organization}/comments

Request

  • Base URL: https://api.planvortex.com/v1.0.0
  • URL: https://api.planvortex.com/v1.0.0/organizations/{id_organization}/comments
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)

Path parameters

id_organizationstring required

Organization identifier

Query parameters

social_networkCommentsCommentNetworkName[]

Filter by network. Repeat the parameter for several (?social_network=youtube&social_network=instagram); a comma-separated string is read as one network name and silently matches nothing.

id_accountstring

Only comments on this connected account

id_publicationstring

Only comments on this publication of yours. Reviews never match it: a review hangs off the listing and has no publication.

unreadboolean

Only unread ones. Any value other than the literal false turns the filter on.

searchstring

Case-insensitive substring match on the comment text

ratinginteger[]

Only comments with these star ratings. Repeat the parameter for several (?rating=1&rating=2), which is the usual way to work a listing: show me the one- and two-star reviews first.

Only review networks carry a rating, so this filter leaves everything else out — it is not a way to select "comments without a rating".

offsetinteger
limitinteger

Response

Successful operation

totalinteger required

Rows matching the filters, not rows returned

Example response

{
  "comments": [
    {
      "id_publication": {
        "files": [
          {
            "file_properties": {
              "aspect_ratio": {
                "value": 1.7777777777777777,
                "text": "16:9"
              }
            },
            "public_path": "https://a1b2c3d4e5f6.eu.r2.cloudflarestorage.com/planvortex-prod/orgs/60b.../60c.../foto.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=86400&X-Amz-Signature=..."
          }
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.