Skip to content

docs: GET /api/artists/{id}/segments (replaces /api/artist/segments) #135

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

Closed
arpitgupta1214 wants to merge 1 commit into from
Closed

docs: GET /api/artists/{id}/segments (replaces /api/artist/segments) #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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.

5 changes: 5 additions & 0 deletions api-reference/artists/segments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Get Artist Segments'
description: 'Retrieve all segments associated with an artist. Supports pagination.'
openapi: "/api-reference/openapi/releases.json GET /api/artists/{id}/segments"
---
33 changes: 28 additions & 5 deletions api-reference/openapi/releases.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,14 +566,14 @@
}
}
},
"/api/artist/segments": {
"/api/artists/{id}/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",
"name": "id",
"in": "path",
"description": "Artist account ID to fetch segments for.",
"required": true,
"schema": {
"type": "string",
Expand Down Expand Up @@ -614,7 +614,30 @@
}
},
"400": {
"description": "Bad request - missing required parameters",
"description": "Bad request - invalid artist ID path parameter or query parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistSegmentsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - missing or invalid authentication"
},
"403": {
"description": "Forbidden - the authenticated account cannot access this artist",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistSegmentsErrorResponse"
}
}
}
},
"500": {
"description": "Server error while retrieving segments",
"content": {
"application/json": {
"schema": {
Expand Down
2 changes: 1 addition & 1 deletion docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"api-reference/artists/pin",
"api-reference/artists/unpin",
"api-reference/artists/delete",
"api-reference/artist/segments",
"api-reference/artists/segments",
"api-reference/artist/socials",
"api-reference/artist/socials-scrape",
"api-reference/artist/profile"
Expand Down