Skip to content

chore: remove dead segments surface #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sweetmantech merged 2 commits into from
Apr 17, 2026
Merged

chore: remove dead segments surface #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d660aac
chore: remove dead segments surface from docs
arpitgupta1214 Apr 16, 2026
4d7c6a7
chore: rename Fans & Segments nav group to Fans
arpitgupta1214 Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions api-reference/artist/segments.mdx
View file
Open in desktop

This file was deleted.

4 changes: 0 additions & 4 deletions api-reference/chat/segment.mdx
View file
Open in desktop

This file was deleted.

353 changes: 0 additions & 353 deletions api-reference/openapi/releases.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,66 +566,6 @@
}
}
},
"/api/artist/segments": {
"get": {
"description": "Retrieve all segments associated with an artist. This endpoint should be called before using the Segment Fans endpoint to obtain the necessary segment IDs. Supports pagination.",
"parameters": [
{
"name": "artist_account_id",
"in": "query",
"description": "The unique identifier of the artist account to fetch segments for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve (default: 1)",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "limit",
"in": "query",
"description": "The number of records per page (default: 20, max: 100)",
"required": false,
"schema": {
"type": "integer",
"default": 20,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Segments retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistSegmentsResponse"
}
}
}
},
"400": {
"description": "Bad request - missing required parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistSegmentsErrorResponse"
}
}
}
}
}
}
},
"/api/artist/socials": {
"get": {
"description": "Retrieve all social media profiles associated with an artist. This endpoint should be called before using the Social Posts endpoint to obtain the necessary social IDs.",
Expand Down Expand Up @@ -742,71 +682,6 @@
}
}
},
"/api/segment/fans": {
"get": {
"servers": [
{
"url": "https://api.recoupable.com"
}
],
"description": "Retrieve all social profiles from fans within a specific segment. This endpoint should be called after obtaining segment IDs from the Artist Segments endpoint. Supports pagination for large fan lists.",
"parameters": [
{
"name": "segment_id",
"in": "query",
"description": "The unique identifier of the segment to fetch fans for",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve (default: 1)",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "limit",
"in": "query",
"description": "The number of records per page (default: 20, max: 100)",
"required": false,
"schema": {
"type": "integer",
"default": 20,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "Segment fans retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentFansResponse"
}
}
}
},
"400": {
"description": "Bad request - missing required parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentFansErrorResponse"
}
}
}
}
}
}
},
"/api/fans": {
"get": {
"servers": [
Expand Down Expand Up @@ -1770,108 +1645,6 @@
}
}
},
"ArtistSegment": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID of the artist_segments record"
},
"artist_account_id": {
"type": "string",
"format": "uuid",
"description": "UUID of the artist's accounts record"
},
"segment_id": {
"type": "string",
"format": "uuid",
"description": "UUID of the segments record"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "ISO timestamp of when the segment data was last updated"
},
"segment_name": {
"type": "string",
"description": "Name of the segment (e.g., 'Twitter Followers')"
},
"artist_name": {
"type": "string",
"description": "Name of the artist"
}
}
},
"ArtistSegmentsErrorResponse": {
"type": "object",
"required": [
"status",
"message"
],
"properties": {
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Status of the request"
},
"message": {
"type": "string",
"description": "Error message describing what went wrong"
}
}
},
"ArtistSegmentsPagination": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "Total number of segments available"
},
"page": {
"type": "integer",
"description": "Current page number"
},
"limit": {
"type": "integer",
"description": "Number of segments per page"
},
"total_pages": {
"type": "integer",
"description": "Total number of pages available"
}
}
},
"ArtistSegmentsResponse": {
"type": "object",
"required": [
"status",
"segments",
"pagination"
],
"properties": {
"status": {
"type": "string",
"enum": [
"success"
],
"description": "Status of the request"
},
"segments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistSegment"
},
"description": "List of segment objects associated with the artist"
},
"pagination": {
"$ref": "#/components/schemas/ArtistSegmentsPagination",
"description": "Pagination metadata for the response"
}
}
},
"ArtistSocial": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -2682,132 +2455,6 @@
}
}
},
"SegmentFan": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the fan_segments record"
},
"username": {
"type": "string",
"description": "Username or handle on the platform"
},
"avatar": {
"type": "string",
"description": "URL to the fan's avatar/profile image"
},
"profile_url": {
"type": "string",
"description": "Full URL to the fan's profile on the platform"
},
"segment_id": {
"type": "string",
"format": "uuid",
"description": "UUID of the fan's segments record"
},
"segment_name": {
"type": "string",
"description": "Name of the segment (e.g., 'Twitter Followers')"
},
"fan_social_id": {
"type": "string",
"format": "uuid",
"description": "UUID of the fan's socials media profile account"
},
"region": {
"type": "string",
"description": "Geographic region or location of the fan"
},
"bio": {
"type": "string",
"description": "Fan's biography or profile description"
},
"follower_count": {
"type": "integer",
"description": "Number of followers the fan has"
},
"following_count": {
"type": "integer",
"description": "Number of accounts the fan is following"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "ISO timestamp of when the fan data was last updated"
}
}
},
"SegmentFansErrorResponse": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Status of the request"
},
"error": {
"type": "string",
"description": "Error message describing what went wrong"
}
}
},
"SegmentFansPagination": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"description": "Total number of records available"
},
"page": {
"type": "integer",
"description": "Current page number"
},
"limit": {
"type": "integer",
"description": "Number of records per page"
},
"total_pages": {
"type": "integer",
"description": "Total number of pages available"
}
}
},
"SegmentFansResponse": {
"type": "object",
"required": [
"status",
"fans",
"pagination"
],
"properties": {
"status": {
"type": "string",
"enum": [
"success"
],
"description": "Status of the request"
},
"fans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SegmentFan"
},
"description": "List of social profiles from fans in the segment"
},
"pagination": {
"$ref": "#/components/schemas/SegmentFansPagination",
"description": "Pagination metadata for the response"
}
}
},
"SocialProfile": {
"type": "object",
"properties": {
Expand Down
Loading