Search Feedback

Search feedback conversations submitted by your organization.

Conversations are used to track feedback on existing events for example feedback on incorrect attendance or start and end dates for an event. Each piece of feedback submitted by a user is tracked as a conversation and will be returned by this endpoint. You can use this to display a list of event feedback conversations submitted with Loop Links by users in your application.
Request
HTTP Request
GET https://api.predicthq.com/v1/loop/feedback/conversations
Query Parameters
Parameter
Description
q
string
Full-text search over conversations.

E.g. ?q=event+a+cancelled
link_id
string
Comma separated list of loop link ids through which conversations were created.

E.g ?link_id=m4Dk4g4DRA8Yqbp2PC54
conversation_id
string
Comma separated list of conversation ids.

E.g ?conversation_id=Eeh4ahnohghah0deeshahda
record_id
string
Comma separated list of event ids for which to fetch the related feedbacks.

E.g ?record_id=5uRg7CqGu7DTtu4Rfk
record_type
string
Comma separated list of record types for which to filter for.

Possible values:
event-public
event-loop
​
Use event-public for loop links feedback conversations.

E.g ?record_type=event-public
feedback_type
string
Comma separated list of feedback types.

Possible values:
attendance_or_rank
category
dates
general
polygon
venue
E.g ?feedback_type=general
user_id
string
Comma separated list of user IDs that submitted those conversations.

E.g ?user_id=hw8Dsmv4Djg
status
string
Comma separated list of feedback status.

Possible values:
open
closed
E.g ?status=open
created
string
The date from and/or to the feedback has been created.

Must be used with one of more of the suffixes:
lt
lte
gt
gte
E.g. ?created.gt=2023-03-04&created.lte=2023-05-01
updated
string
The date from and/or to the feedback has been updated.
​
Must be used with one of more of the suffixes:
lt
lte
gt
gte
E.g. ?updated.gt=2023-03-04&updated.lte=2023-05-01
sort
string
Comma-separated list of sort options.

Prefix the field name with - for reverse order.

Possible values:
created
updated
relevance
Default value is ?sort=relevance,created

E.g. ?sort=-updated
limit
number
The maximum number of results to return.
​
The default limit is 10.

E.g. ?limit=10
offset
number
The number of results to skip.
​
The default is 0.

E.g. ?offset=20
Response
Response Fields
Field
Description
count
number
Total number of results found.
conversations
array
List of results where each item is a Conversation.

Please refer to the Conversation Response Fields section below for the structure of each record.
Conversation Response Fields
Field
Description
conversation_id
string
The unique identifier of the conversation.

E.g. Eeh4ahnohghah0deeshahda
create_dt
string
The creation date time for the record in ISO 8601 format format.

E.g. 2022-04-26T11:46:24+00:00
update_dt
string
The last update date time for the location in ISO 8601 format format.

E.g. 2022-04-26T11:46:24+00:00
link_id
string
Loop Link ID that was used to submit this feedback.

Will only be available on feedback created with a Loop Link.

E.g. m4Dk4g4DRA8Yqbp2PC54
record_id
string
​
record_type
string
​
feedback
object
Feedback can be provided for different fields.
​
Possible types:
attendance_or_rank - Attendance or Rank
category - Category might need adjusting
dates - Dates might need adjusting
duplicate - Record might be a duplicate
general - Other feedback
polygon - Polygon might need adjusting
submitted - Feedback about an existing Loop submission
venue - Venue might need adjusting
​
E.g.
{
  "feedback": {
    "type": "submitted"
  }
}
log
array
Log of actions taken with the feedback.

E.g.
{
  "log": [
    {
      "action": {
        "type": "comment"
      },
      "timestamp": "2023-05-30T02:59:11+00:00",
      "creator": {
        "type": "user",
        "user_id": "hw8Dsmv4Djg"
      },
      "note": "Thank you for your feedback. Someone from PredictHQ will pick this up."
    }
  ]
}
status
string
Status of the feedback.

Possible values:
open
closed
E.g. open
Example response
Below is an example response:
{
  "count": 1,
  "conversations": [
    {
      "conversation_id": "Eeh4ahnohghah0deeshahda",
      "create_dt": "2021-05-25T05:33:53+00:00",
      "update_dt": "2021-05-25T05:38:08+00:00",
      "link_id": "m4Dk4g4DRA8Yqbp2PC54",
      "record_id": "5uRg7CqGu7DTtu4Rfk",
      "record_type": "event-public",
      "feedback": {
        "type": "submitted"
      },
      "log": [
        {
          "action": {
            "type": "created"
          },
          "timestamp": "2023-05-30T02:44:46+00:00",
          "creator": {
            "type": "unauthenticated_user",
            "link_id": "m4Dk4g4DRA8Yqbp2PC54"
          },
          "note": "This event title should be different"
        },
        {
          "action": {
            "type": "comment"
          },
          "timestamp": "2023-05-30T02:59:11+00:00",
          "creator": {
            "type": "user",
            "user_id": "hw8Dsmv4Djg"
          },
          "note": "Thank you for your feedback. Someone from PredictHQ will pick this up."
        },
        {
          "action": {
            "type": "comment"
          },
          "timestamp": "2023-05-30T03:41:06+00:00",
          "creator": {
            "type": "moderator"
          },
          "note": "Absolutely, we'll change this right away "
        }
      ],
      "status": "open"
    }
  ]
}
Examples
curl
python
curl -X GET https://api.predicthq.com/v1/loop/feedback/conversations?link_id=m4Dk4g4DRA8Yqbp2PC54 \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $ACCESS_TOKEN"
import requests
​
response = requests.get(
    url="https://api.predicthq.com/v1/loop/events",
    headers={
      "Authorization": "Bearer $ACCESS_TOKEN",
      "Accept": "application/json"
    },
    params={
        "link_id": "m4Dk4g4DRA8Yqbp2PC54"
    }
)
​
print(response.json())
Guides
Below are some guides relevant to this API:
​Integrate with Loop Links​

Parameter	Description
`q` string	Full-text search over conversations. E.g. `?q=event+a+cancelled`
`link_id` string	Comma separated list of loop link ids through which conversations were created. E.g `?link_id=m4Dk4g4DRA8Yqbp2PC54`
`conversation_id` string	Comma separated list of conversation ids. E.g `?conversation_id=Eeh4ahnohghah0deeshahda`
`record_id` string	Comma separated list of event ids for which to fetch the related feedbacks. E.g `?record_id=5uRg7CqGu7DTtu4Rfk`
`record_type` string	Comma separated list of record types for which to filter for. Possible values: `event-public` `event-loop` Use `event-public` for loop links feedback conversations. E.g `?record_type=event-public`
`feedback_type` string	Comma separated list of feedback types. Possible values: `attendance_or_rank` `category` `dates` `general` `polygon` `venue` E.g `?feedback_type=general`
`user_id` string	Comma separated list of user IDs that submitted those conversations. E.g `?user_id=hw8Dsmv4Djg`
`status` string	Comma separated list of feedback status. Possible values: `open` `closed` E.g `?status=open`
`created` string	The date from and/or to the feedback has been created. Must be used with one of more of the suffixes: `lt` `lte` `gt` `gte` E.g. `?created.gt=2023-03-04&created.lte=2023-05-01`
`updated` string	The date from and/or to the feedback has been updated. Must be used with one of more of the suffixes: `lt` `lte` `gt` `gte` E.g. `?updated.gt=2023-03-04&updated.lte=2023-05-01`
`sort` string	Comma-separated list of sort options. Prefix the field name with `-` for reverse order. Possible values: `created` `updated` `relevance` Default value is `?sort=relevance,created` E.g. `?sort=-updated`
`limit` number	The maximum number of results to return. The default limit is `10`. E.g. `?limit=10`
`offset` number	The number of results to skip. The default is `0`. E.g. `?offset=20`

Field	Description
`count` number	Total number of results found.
`conversations` array	List of results where each item is a Conversation. Please refer to the Conversation Response Fields section below for the structure of each record.

Field	Description
`conversation_id` string	The unique identifier of the conversation. E.g. `Eeh4ahnohghah0deeshahda`
`create_dt` string	The creation date time for the record in ISO 8601 format format. E.g. `2022-04-26T11:46:24+00:00`
`update_dt` string	The last update date time for the location in ISO 8601 format format. E.g. `2022-04-26T11:46:24+00:00`
`link_id` string	Loop Link ID that was used to submit this feedback. Will only be available on feedback created with a Loop Link. E.g. `m4Dk4g4DRA8Yqbp2PC54`
`record_id` string
`record_type` string
`feedback` object	Feedback can be provided for different fields. Possible types: `attendance_or_rank` - Attendance or Rank `category` - Category might need adjusting `dates` - Dates might need adjusting `duplicate` - Record might be a duplicate `general` - Other feedback `polygon` - Polygon might need adjusting `submitted` - Feedback about an existing Loop submission `venue` - Venue might need adjusting E.g. { "feedback": { "type": "submitted" } }
`log` array	Log of actions taken with the feedback. E.g. { "log": [ { "action": { "type": "comment" }, "timestamp": "2023-05-30T02:59:11+00:00", "creator": { "type": "user", "user_id": "hw8Dsmv4Djg" }, "note": "Thank you for your feedback. Someone from PredictHQ will pick this up." } ] }
`status` string	Status of the feedback. Possible values: `open` `closed` E.g. `open`

Loop Feedback

Next - API Reference

Places

Last modified 1mo ago