Skip to main content
POST
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
reddit_listenings
Create reddit listening
curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/reddit_listenings \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "category": "<string>",
  "language": "<string>",
  "brand": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "collect_start_date": "2023-12-25",
  "created_by_email": "<string>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organization_id
string
required
​
workspace_id
string<uuid>
required

Body

​
name
string
required
​
analysis_id
string<uuid>
required

ID of the analysis from which to create the reddit listening

​
period
enum<string>
required

Period of the reddit listening window. If it's one month, the data will be collected from one month ago until today.

  • last_month - last month
  • last_three_months - last three months
  • last_six_months - last six months
Available options:
last_month,
last_three_months,
last_six_months

Response

Reddit listening created successfully.

​
id
string<uuid>
required
read-only
​
category
string
required
read-only
​
language
string
required
read-only
​
brand
string
required
read-only
​
workspace_id
string<uuid>
required
​
created_at
string<date-time>
required
read-only
​
created_by
string<uuid>
required
​
name
string
required
Maximum string length: 255
​
collect_start_date
string<date>
required
​
created_by_email
string
​
status
enum<string>
  • pending - pending
  • collecting - collecting
  • ready - ready
  • failed - failed
Available options:
pending,
collecting,
ready,
failed