{ "openapi": "3.1.0", "info": { "title": "PublishBuddy", "version": "0.0.1" }, "servers": [ { "url": "https:\/\/api.publishbuddy.com\/v1" } ], "paths": { "\/analytics\/best_times": { "get": { "operationId": "bestTimes.index", "summary": "Show best posting times heatmap", "tags": [ "BestTimes" ], "parameters": [ { "name": "from", "in": "query", "required": true, "description": "Start date in Y-m-d or full datetime format.", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": true, "description": "End date in Y-m-d or full datetime format. Must be greater than or equal to `from`.", "schema": { "type": "string", "format": "date-time" } }, { "name": "profile", "in": "query", "description": "Profile UUID. Provide either `profile` or `workspace`.", "schema": { "type": [ "string", "null" ], "format": "uuid" } }, { "name": "workspace", "in": "query", "description": "Workspace UUID. Provide either `workspace` or `profile`.", "schema": { "type": [ "string", "null" ], "format": "uuid" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "`BestTimesResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/BestTimesResource" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/media_contents\/{mediaContent}": { "get": { "operationId": "v1.media_contents.show", "summary": "Get media info", "tags": [ "MediaContent" ], "parameters": [ { "name": "mediaContent", "in": "path", "required": true, "description": "The media content UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "`MediaContentResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/MediaContentResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "v1.media_contents.update", "summary": "Update media", "tags": [ "MediaContent" ], "parameters": [ { "name": "mediaContent", "in": "path", "required": true, "description": "The media content UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateMediaContentRequest" } } } }, "responses": { "200": { "description": "`MediaContentResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/MediaContentResource" }, "message": { "type": "string" } }, "required": [ "data", "message" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "delete": { "operationId": "v1.media_contents.destroy", "summary": "Delete media", "tags": [ "MediaContent" ], "parameters": [ { "name": "mediaContent", "in": "path", "required": true, "description": "The media content UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "`JsonResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/JsonResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/workspaces\/{workspace}\/media_contents": { "get": { "operationId": "v1.workspaces.media_contents.index", "summary": "List of medias", "tags": [ "MediaContent" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace UUID", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "folder_id", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "Paginated set of `MediaContentResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaContentResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "from": { "type": [ "integer", "null" ] }, "last_page": { "type": "integer" }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page." }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice." }, "total": { "type": "integer", "description": "Total number of items being paginated." } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/workspaces\/{workspace}\/media_contents\/presign": { "post": { "operationId": "mediaContent.presign", "summary": "Issue pre-signed direct-to-storage upload URLs", "tags": [ "MediaContent" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PresignMediaContentRequest" } } } }, "responses": { "200": { "description": "Array of `PresignedMediaUploadResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PresignedMediaUploadResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/workspaces\/{workspace}\/media_contents\/confirm": { "post": { "operationId": "mediaContent.confirm", "summary": "Finalize direct uploads that already landed in storage", "tags": [ "MediaContent" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ConfirmMediaContentRequest" } } } }, "responses": { "200": { "description": "Array of `MediaContentResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaContentResource" } }, "message": { "type": "string" } }, "required": [ "data", "message" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/workspaces\/{workspace}\/media_library\/folders": { "get": { "operationId": "mediaLibraryFolder.index", "summary": "List media library folders", "tags": [ "MediaLibraryFolder" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace UUID", "schema": { "type": "string" } }, { "name": "root", "in": "query", "schema": { "type": "boolean" } }, { "name": "parent_id", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "Array of `MediaLibraryFolderResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaLibraryFolderResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "post": { "operationId": "mediaLibraryFolder.store", "summary": "Create media library folder", "tags": [ "MediaLibraryFolder" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreMediaLibraryFolderRequest" } } } }, "responses": { "200": { "description": "`MediaLibraryFolderResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/MediaLibraryFolderResource" }, "message": { "type": "string" } }, "required": [ "data", "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/media_library\/folders\/{folder}": { "get": { "operationId": "mediaLibraryFolder.show", "summary": "Show media library folder details", "tags": [ "MediaLibraryFolder" ], "parameters": [ { "name": "folder", "in": "path", "required": true, "description": "The folder UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "`MediaLibraryFolderResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/MediaLibraryFolderResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "patch": { "operationId": "mediaLibraryFolder.update", "summary": "Update media library folder", "tags": [ "MediaLibraryFolder" ], "parameters": [ { "name": "folder", "in": "path", "required": true, "description": "The folder UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateMediaLibraryFolderRequest" } } } }, "responses": { "200": { "description": "`MediaLibraryFolderResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/MediaLibraryFolderResource" }, "message": { "type": "string" } }, "required": [ "data", "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "delete": { "operationId": "mediaLibraryFolder.destroy", "summary": "Delete media library folder", "tags": [ "MediaLibraryFolder" ], "parameters": [ { "name": "folder", "in": "path", "required": true, "description": "The folder UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "`JsonResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/JsonResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/posts\/{post}": { "get": { "operationId": "v1.posts.show", "summary": "Show post", "tags": [ "Post" ], "parameters": [ { "name": "post", "in": "path", "required": true, "description": "The post UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "`PostResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/PostResource" } }, "required": [ "data" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "v1.posts.update", "summary": "Update post", "tags": [ "Post" ], "parameters": [ { "name": "post", "in": "path", "required": true, "description": "The post UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "`PostResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/PostResource" }, "message": { "type": "string" } }, "required": [ "data", "message" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } }, "delete": { "operationId": "v1.posts.destroy", "summary": "Delete post", "tags": [ "Post" ], "parameters": [ { "name": "post", "in": "path", "required": true, "description": "The post UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "`JsonResource`", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object" }, { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/JsonResource" } }, "required": [ "data" ] } ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/workspaces\/{workspace}\/posts": { "get": { "operationId": "v1.workspaces.posts.index", "summary": "Get posts", "tags": [ "Post" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace UUID", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "statuses", "in": "query", "schema": { "type": "string" } }, { "name": "filters[social_account_ids][]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters[profile_ids]", "in": "query", "schema": { "type": "string" } }, { "name": "filters[search]", "in": "query", "schema": { "type": "string" } }, { "name": "filters[publish_type]", "in": "query", "schema": { "type": "string" } }, { "name": "filters[publish_types][]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters[labels][]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters[post_type_id]", "in": "query", "schema": { "type": "string" } }, { "name": "filters[date_range][]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters[publish_range][]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters[sort_by]", "in": "query", "schema": { "type": "string" } }, { "name": "published_at", "in": "query", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "Paginated set of `PostResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PostResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "from": { "type": [ "integer", "null" ] }, "last_page": { "type": "integer" }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page." }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice." }, "total": { "type": "integer", "description": "Total number of items being paginated." } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] }, "waiting_count": { "type": "string" }, "publishing_count": { "type": "string" }, "published_count": { "type": "string" }, "failed_count": { "type": "string" }, "needs_approval_count": { "type": "string" }, "draft_count": { "type": "string" } }, "required": [ "data", "links", "meta", "waiting_count", "publishing_count", "published_count", "failed_count", "needs_approval_count", "draft_count" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "post": { "operationId": "v1.workspaces.posts.store", "summary": "Create post", "tags": [ "Post" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace UUID", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "`PostResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/PostResource" }, "message": { "type": "string" } }, "required": [ "data", "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/workspaces\/{workspace}\/profiles": { "get": { "operationId": "v1.workspaces.profiles.index", "summary": "Get list of profiles", "tags": [ "Profile" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace UUID", "schema": { "type": "string" } }, { "name": "order[name]", "in": "query", "schema": { "type": "string", "enum": [ "profiles.id", "social_profiles.name" ] } }, { "name": "order[value]", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "Array of `ProfileResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ProfileResource" } } }, "required": [ "data" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/analytics\/profiles\/{profile}": { "get": { "operationId": "profileAnalytics.show", "summary": "Show profile analytics", "tags": [ "ProfileAnalytics" ], "parameters": [ { "name": "profile", "in": "path", "required": true, "description": "The profile UUID", "schema": { "type": "string" } }, { "name": "post_type_id", "in": "query", "description": "Filter posts by post type ID.", "schema": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11" ] } }, { "name": "timeframe", "in": "query", "description": "Predefined timeframe value, e.g. last_7_days.", "schema": { "type": "string", "enum": [ "last_14_days", "last_7_days", "last_30_days", "last_90_days", "prev_month", "this_month", "this_week", "for_all_time" ] } }, { "name": "order[name]", "in": "query", "description": "Sort field name.", "schema": { "type": "string", "enum": [ "social_posts.post_created_at", "post_metrics.likes", "post_metrics.comments", "post_metrics.shares", "post_metrics.total_engagement", "post_metrics.engagement_rate", "post_metrics.reach" ] } }, { "name": "order[value]", "in": "query", "description": "Sort direction.", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "`ProfileAnalyticsResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ProfileAnalyticsResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/profiles\/{profile}\/hashtags": { "get": { "operationId": "profileHashtags.index", "summary": "List profile hashtags", "tags": [ "ProfileHashtags" ], "parameters": [ { "name": "profile", "in": "path", "required": true, "description": "The profile UUID", "schema": { "type": "string" } }, { "name": "timeframe", "in": "query", "schema": { "type": "string", "enum": [ "last_14_days", "last_7_days", "last_30_days", "last_90_days", "prev_month", "this_month", "this_week", "for_all_time" ] } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "Array of `HashtagResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HashtagResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/profiles\/{profile}\/metrics": { "get": { "operationId": "profileMetrics.index", "summary": "Show profile metrics", "tags": [ "ProfileMetrics" ], "parameters": [ { "name": "profile", "in": "path", "required": true, "description": "The profile UUID", "schema": { "type": "string" } }, { "name": "timeframe", "in": "query", "required": true, "description": "Aggregation timeframe, e.g. last_7_days, last_30_days, this_month.", "schema": { "type": "string", "enum": [ "last_14_days", "last_7_days", "last_30_days", "last_90_days", "prev_month", "this_month", "this_week", "for_all_time" ] } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "`ProfileMetricsResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ProfileMetricsResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/workspaces": { "get": { "operationId": "v1.", "summary": "Workspaces the authenticated user can access", "tags": [ "Workspace" ], "parameters": [ { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "Array of `WorkspaceResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorkspaceResource" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/analytics\/workspaces\/{workspace}": { "get": { "operationId": "workspaceAnalytics.show", "summary": "Cumulative metrics for all social posts tied to profiles in this workspace", "tags": [ "WorkspaceAnalytics" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace UUID", "schema": { "type": "string" } }, { "name": "post_type_id", "in": "query", "description": "Filter posts by post type ID.", "schema": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11" ] } }, { "name": "timeframe", "in": "query", "description": "Predefined timeframe value, e.g. last_7_days.", "schema": { "type": "string", "enum": [ "last_14_days", "last_7_days", "last_30_days", "last_90_days", "prev_month", "this_month", "this_week", "for_all_time" ] } }, { "name": "order[name]", "in": "query", "description": "Sort field name.", "schema": { "type": "string", "enum": [ "social_posts.post_created_at", "post_metrics.likes", "post_metrics.comments", "post_metrics.shares", "post_metrics.total_engagement", "post_metrics.engagement_rate", "post_metrics.reach" ] } }, { "name": "order[value]", "in": "query", "description": "Sort direction.", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "`WorkspaceAnalyticsResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WorkspaceAnalyticsResource" } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/workspaces\/{workspace}\/hashtags": { "get": { "operationId": "workspaceHashtags.index", "summary": "List workspace hashtags", "tags": [ "WorkspaceHashtags" ], "parameters": [ { "name": "workspace", "in": "path", "required": true, "description": "The workspace UUID", "schema": { "type": "string" } }, { "name": "timeframe", "in": "query", "schema": { "type": "string", "enum": [ "last_14_days", "last_7_days", "last_30_days", "last_90_days", "prev_month", "this_month", "this_week", "for_all_time" ] } }, { "name": "Authorization", "in": "header", "required": true, "description": "JWT token.", "schema": { "type": "string" }, "example": "Bearer 123" } ], "responses": { "200": { "description": "Array of `HashtagResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HashtagResource" } } }, "required": [ "data" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } } }, "components": { "schemas": { "BestTimeToPostResource": { "type": "object", "properties": { "weekDay": { "type": "integer" }, "hour": { "type": "integer" }, "score": { "type": "integer" } }, "required": [ "weekDay", "hour", "score" ], "title": "BestTimeToPostResource" }, "BestTimesResource": { "type": "object", "properties": { "heatmap": { "type": "object", "properties": { "Sunday": { "anyOf": [ { "type": "string" }, { "type": "array", "items": {} } ] }, "Monday": { "anyOf": [ { "type": "string" }, { "type": "array", "items": {} } ] }, "Tuesday": { "anyOf": [ { "type": "string" }, { "type": "array", "items": {} } ] }, "Wednesday": { "anyOf": [ { "type": "string" }, { "type": "array", "items": {} } ] }, "Thursday": { "anyOf": [ { "type": "string" }, { "type": "array", "items": {} } ] }, "Friday": { "anyOf": [ { "type": "string" }, { "type": "array", "items": {} } ] }, "Saturday": { "anyOf": [ { "type": "string" }, { "type": "array", "items": {} } ] } }, "required": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] } }, "required": [ "heatmap" ], "title": "BestTimesResource" }, "CommentResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "text": { "type": "string", "description": "Text of comment" }, "delay_n": { "type": [ "integer", "null" ], "description": "Amount of time to delay the post, represented as a number" }, "delay_type": { "type": "string", "description": "Unit of time used for delay. Example: minutes, hours, days" }, "media_ids": { "type": "array", "description": "Attached media UUIDs", "items": { "type": "string" } }, "media": { "type": "object", "description": "Media content Info which included in comment", "properties": { "media_id": { "type": "string" }, "type": { "type": "string" }, "width": { "type": [ "integer", "null" ] }, "height": { "type": [ "integer", "null" ] }, "duration": { "type": [ "integer", "null" ] } }, "required": [ "media_id", "type", "width", "height", "duration" ] } }, "required": [ "id", "text", "delay_n", "delay_type", "media_ids", "media" ], "title": "CommentResource" }, "ConfirmMediaContentRequest": { "type": "object", "properties": { "uuids": { "type": "array", "description": "UUIDs of temporary media items returned by presign (1\u201310 per request)", "items": { "type": "string", "format": "uuid", "description": "Each UUID must belong to the workspace and be awaiting upload confirmation" }, "maxItems": 10 } }, "required": [ "uuids" ], "title": "ConfirmMediaContentRequest" }, "ConnectionResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "user_id": { "type": "string", "description": "User ID" }, "status": { "type": "string", "description": "Connection Status. Possible Values: Active, Failed" }, "type": { "type": "string", "description": "Connection type. Possible Values: OwnersAccountConnection, MembersAccountConnection" } }, "required": [ "id", "user_id", "status", "type" ], "title": "ConnectionResource" }, "DatetimeslotResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "datetime": { "type": "string", "description": "Date time format by: Y-m-d H:i" }, "date": { "type": "string", "description": "Date format by: Y-m-d" }, "time": { "type": "string", "description": "Time format by: H:i" } }, "required": [ "id", "datetime", "date", "time" ], "title": "DatetimeslotResource" }, "HashtagResource": { "type": "object", "properties": { "name": { "type": "string", "description": "Hashtag name" }, "engagement": { "type": "string", "description": "Overall engagement rate for total hashtag usages" }, "reach": { "type": "string", "description": "Overall reach rate for total hashtag usages" } }, "required": [ "name", "engagement", "reach" ], "title": "HashtagResource" }, "JsonResource": { "type": "string", "title": "JsonResource" }, "MediaContentResource": { "type": "object", "properties": { "id": { "type": "string", "description": "UUID" }, "name": { "type": "string", "description": "Name of media file" }, "full_name": { "type": "string", "description": "Full relative name" }, "label": { "type": [ "string", "null" ], "description": "Label of media" }, "link": { "type": "string", "description": "Full link to media" }, "size": { "type": [ "integer", "null" ], "description": "Media size in bytes" }, "width": { "type": [ "integer", "null" ], "description": "Width in pixel" }, "height": { "type": [ "integer", "null" ], "description": "Height in pixel" }, "time": { "type": [ "integer", "null" ], "description": "Time is second" }, "folder_id": { "type": "string" } }, "required": [ "id", "name", "full_name", "label", "link", "size", "width", "height", "time", "folder_id" ], "title": "MediaContentResource" }, "MediaLibraryFolderResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "parent_id": { "type": "string" } }, "required": [ "id", "name", "parent_id" ], "title": "MediaLibraryFolderResource" }, "NetworkResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "name": { "type": "string", "description": "Network Name" }, "profile_types": { "type": "array", "description": "Profile Type Info", "items": { "$ref": "#\/components\/schemas\/ProfileTypeResource" } }, "support_analytics": { "type": "string", "description": "Is network support analytics" }, "support_engage": { "type": "string", "description": "Is network support engage" } }, "required": [ "id", "name", "profile_types", "support_analytics", "support_engage" ], "title": "NetworkResource" }, "PermissionResource": { "type": "object", "properties": { "name": { "type": "string", "description": "Permission name" } }, "required": [ "name" ], "title": "PermissionResource" }, "PostDestinationResource": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Target account UUID" }, "account_name": { "type": "string", "description": "Human-readable account name" }, "platform": { "type": [ "string", "null" ], "description": "Platform slug (e.g. `facebook`, `instagram`)" }, "platform_post_id": { "type": "string", "description": "Platform-native post identifier when published" }, "platform_post_url": { "type": "null", "description": "Public URL of the published post" }, "published_at": { "type": "string", "description": "Publish time in ISO 8601 UTC" }, "error": { "type": "string", "description": "Publish error message, if any" }, "status": { "description": "Destination status: `queued`, `publishing`, `published`, `failed`, or pivot `status`", "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "published", "publishing", "failed", "queued" ] } ] } }, "required": [ "account_id", "account_name", "platform", "platform_post_id", "platform_post_url", "published_at", "error", "status" ], "title": "PostDestinationResource" }, "PostResource": { "type": "object", "properties": { "post_id": { "type": "string", "description": "Post UUID (same as `id`)" }, "id": { "type": "string", "description": "Post UUID (alias of `post_id`)" }, "content": { "type": "string", "description": "Post text" }, "account_ids": { "type": "array", "description": "Account UUIDs from scheduled-profile history (append-only)", "items": { "type": "string" } }, "scheduled_for": { "type": [ "string", "null" ], "description": "Scheduled publish time in ISO 8601 UTC" }, "timezone": { "type": "string", "description": "Timezone echoed from the request (default `UTC`)" }, "media_ids": { "type": "array", "description": "Attached media UUIDs", "items": { "type": "string" } }, "media": { "type": "object", "description": "Attached media metadata", "properties": { "media_id": { "type": "string" }, "type": { "type": "string" }, "width": { "type": [ "integer", "null" ] }, "height": { "type": [ "integer", "null" ] }, "duration": { "type": [ "integer", "null" ] } }, "required": [ "media_id", "type", "width", "height", "duration" ] }, "platform_content": { "type": [ "array", "null" ], "description": "Per-platform settings keyed by platform slug (e.g. `instagram`, `tiktok`); null for universal multi-account", "items": {} }, "publish_type": { "type": [ "string", "null" ], "description": "Publish mode: `queue_using_timeslots`, `schedule_using_fixed_datetime`, `now`, `recurring`" }, "status": { "type": [ "string", "null" ], "description": "Post status: `waiting`, `publishing`, `published`, `failed`, `needs_approval`, `draft`" }, "created_at": { "type": "string", "description": "Creation timestamp in ISO 8601 UTC" }, "updated_at": { "type": "string", "description": "Last update timestamp in ISO 8601 UTC" }, "link": { "type": "string", "description": "Optional link attached to the post" }, "labels": { "type": [ "string", "null" ], "description": "Labels when the `labels` relation is eager-loaded; otherwise `null`" }, "comments": { "type": "array", "description": "First-comment thread items", "items": { "$ref": "#\/components\/schemas\/CommentResource" } }, "published_at": { "type": "string", "description": "Actual publish time in ISO 8601 UTC" }, "error_message": { "type": "string", "description": "Last publish error for the active profile" }, "destinations": { "type": "array", "description": "Per-account publish targets from `post_scheduled_profiles`", "items": { "$ref": "#\/components\/schemas\/PostDestinationResource" } } }, "required": [ "post_id", "id", "content", "account_ids", "scheduled_for", "timezone", "media_ids", "media", "platform_content", "publish_type", "status", "created_at", "updated_at", "link", "labels", "comments", "published_at", "error_message", "destinations" ], "title": "PostResource" }, "PresignMediaContentRequest": { "type": "object", "properties": { "files": { "type": "array", "description": "Files to upload (1\u201310 items per request)", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Original filename including extension (e.g. `photo.jpg`)", "maxLength": 255 }, "mime": { "type": [ "string", "null" ], "description": "MIME type (e.g. `image\/jpeg`, `video\/mp4`); optional but recommended", "maxLength": 255 }, "size": { "type": "integer", "description": "Declared file size in bytes (max 2 GB)", "minimum": 1, "maximum": 2147483648 } }, "required": [ "name", "size" ] }, "maxItems": 10 } }, "required": [ "files" ], "title": "PresignMediaContentRequest" }, "PresignedMediaUploadResource": { "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the pre-created (temporary) media item" }, "name": { "type": "string", "description": "Generated storage filename" }, "full_name": { "type": "string", "description": "Full relative storage key" }, "link": { "type": "string", "description": "Public read link (valid once the direct upload completes)" }, "upload_url": { "type": "string", "description": "Pre-signed URL the client must PUT the file bytes to" }, "upload_headers": { "type": "string", "description": "Headers that were signed and must be replayed on the PUT" }, "upload_method": { "type": "string", "description": "HTTP method to use for the direct upload", "enum": [ "PUT" ] }, "expires_in": { "type": "string", "description": "Seconds until the upload URL expires" } }, "required": [ "id", "name", "full_name", "link", "upload_url", "upload_headers", "upload_method", "expires_in" ], "title": "PresignedMediaUploadResource" }, "ProfileAnalyticsResource": { "type": "object", "properties": { "profile_id": { "type": "string" }, "total": { "type": "object", "properties": { "comments": { "type": "string" }, "likes": { "type": "string" }, "shares": { "type": "string" }, "impressions": { "type": "string" }, "quotes": { "type": "string" }, "saves": { "type": "string" }, "engagement_rate": { "type": "string" } }, "required": [ "comments", "likes", "shares", "impressions", "quotes", "saves", "engagement_rate" ] }, "posts": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SocialPostAnalyticsResource" } }, "meta": { "type": "object", "properties": { "current_page": { "type": "string" }, "last_page": { "type": "string" }, "per_page": { "type": "string" }, "total": { "type": "string" } }, "required": [ "current_page", "last_page", "per_page", "total" ] } }, "required": [ "profile_id", "total", "posts", "meta" ], "title": "ProfileAnalyticsResource" }, "ProfileMetricsResource": { "type": "object", "properties": { "new_followers": { "type": "string", "description": "Count new followers" }, "likes": { "type": "string", "description": "Count likes" }, "reach": { "type": "string", "description": "Count of reach" }, "engagements": { "type": "string", "description": "Count of engagement" }, "published_posts": { "type": "string", "description": "Count of published posts" }, "new_followers_compare": { "type": "string", "description": "Compare new followers with same previous period in percent" }, "likes_compare": { "type": "string", "description": "Compare likes with same previous period in percent" }, "reach_compare": { "type": "string", "description": "Compare reach with same previous period in percent" }, "engagements_compare": { "type": "string", "description": "Compare engagement with same previous period in percent" }, "published_posts_compare": { "type": "string", "description": "Compare count of publish posts with same previous period in percent" }, "graphs": { "type": "object", "description": "Graph metrics", "properties": { "gender": { "type": "string", "description": "Gender amount graph" }, "age": { "type": "string", "description": "Age amount graph" }, "page_fans_country": { "type": "string", "description": "Page fans country amount graph" }, "page_fans_city": { "type": "string", "description": "Page fans city amount graph" }, "followers": { "type": "string", "description": "Followers count graph" }, "likes": { "type": "string", "description": "Likes amount graph" }, "post_engagement": { "type": "string", "description": "Post engagement amount graph" }, "post_reach": { "type": "string", "description": "Reach amount graph" }, "link_clicks": { "type": "string", "description": "Link clicks count graph" }, "video_views": { "type": "string", "description": "Video views amount graph" }, "posts": { "type": "string", "description": "Posts amount graph" } }, "required": [ "gender", "age", "page_fans_country", "page_fans_city", "followers", "likes", "post_engagement", "post_reach", "link_clicks", "video_views", "posts" ] }, "best_time_to_post": { "type": "array", "description": "Recommended publication time", "items": { "$ref": "#\/components\/schemas\/BestTimeToPostResource" } } }, "required": [ "new_followers", "likes", "reach", "engagements", "published_posts", "new_followers_compare", "likes_compare", "reach_compare", "engagements_compare", "published_posts_compare", "graphs", "best_time_to_post" ], "title": "ProfileMetricsResource" }, "ProfileResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "workspace": { "description": "Workspace the profile belongs to", "$ref": "#\/components\/schemas\/WorkspaceResource" }, "social_profile": { "description": "Social Profile info", "$ref": "#\/components\/schemas\/SocialProfileResource" }, "account_id": { "type": [ "string", "null" ], "description": "Account ID which the profile is associated with" }, "connected": { "type": "string", "description": "The Profile connection status" }, "queue": { "description": "Queue info", "$ref": "#\/components\/schemas\/QueueResource" }, "schedule": { "description": "Schedule Info", "$ref": "#\/components\/schemas\/ScheduleResource" }, "profile_type": { "description": "Profile Type Info", "$ref": "#\/components\/schemas\/ProfileTypeResource" }, "own_type": { "type": "string", "description": "Profile Own Types \u2014 defines the ownership scope of a social profile within the application. Possible values: workspace, public", "enum": [ "workspace", "public" ] }, "users": { "type": "array", "description": "Users Info", "items": { "$ref": "#\/components\/schemas\/UserResource" } }, "access_level": { "type": "string", "description": "Access level of current user to profile" }, "connections": { "type": "array", "description": "Connections Info", "items": { "$ref": "#\/components\/schemas\/ConnectionResource" } }, "is_facebook_group": { "type": "boolean", "description": "Bool value: Is the profile a facebook group" }, "synchronization_status": { "type": "string", "description": "Shows profile analytics synchronization status.\nPossible values: 0 - Synchronization in Process, 1 - Synchronized, 2 - Failed Synchronization", "enum": [ "synchronization_in_process", "synchronized", "failed_synchronization" ] }, "using_connection": { "description": "The connection that the CURRENT user uses for the profile", "$ref": "#\/components\/schemas\/ConnectionResource" }, "status": { "type": "string", "description": "Profile status. Shows whether the user can do something with this profile\nPossible values: 0 - Inactive, 1 - Active", "enum": [ "inactive", "active" ] } }, "required": [ "id", "workspace", "social_profile", "account_id", "connected", "queue", "schedule", "profile_type", "own_type", "users", "access_level", "connections", "is_facebook_group", "synchronization_status", "using_connection", "status" ], "title": "ProfileResource" }, "ProfileTypeResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "name": { "type": "string", "description": "The name of profile Type. Possible values: profile, group, page, private, supergroup, channel" } }, "required": [ "id", "name" ], "title": "ProfileTypeResource" }, "QueueResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "profile_id": { "type": "string", "description": "Profile ID" }, "timeslots": { "type": "array", "description": "Timeslots Info", "items": { "$ref": "#\/components\/schemas\/TimeslotResource" } } }, "required": [ "id", "profile_id", "timeslots" ], "title": "QueueResource" }, "RoleResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "name": { "type": "string", "description": "Name" } }, "required": [ "id", "name" ], "title": "RoleResource" }, "ScheduleResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "profile_id": { "type": "string", "description": "Profile ID" }, "datetimeslots": { "type": "array", "description": "Datetimeslots info", "items": { "$ref": "#\/components\/schemas\/DatetimeslotResource" } } }, "required": [ "id", "profile_id", "datetimeslots" ], "title": "ScheduleResource" }, "SocialPostAnalyticsResource": { "type": "object", "properties": { "social_post_id": { "type": "string" }, "post_id": { "type": "string" }, "network": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "PUBLISHED", "DRAFT", "FAILED", "NEEDS_APPROVAL", "SCHEDULED" ] }, "post_url": { "type": "string" }, "scheduled_at": { "type": "string" }, "post_type": { "type": "string" }, "analytics": { "anyOf": [ { "type": "object", "properties": { "comments": { "type": "integer" }, "likes": { "type": "integer" }, "shares": { "type": "integer" }, "impressions": { "type": "integer" }, "reach": { "type": "integer" }, "quotes": { "type": "integer" }, "views": { "type": "integer" }, "engagement_rate": { "type": "string" } }, "required": [ "comments", "likes", "shares", "impressions", "reach", "quotes", "views", "engagement_rate" ] }, { "type": "object" } ] } }, "required": [ "social_post_id", "post_id", "network", "status", "post_url", "scheduled_at", "post_type", "analytics" ], "title": "SocialPostAnalyticsResource" }, "SocialProfileEntityResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "name": { "type": "string", "description": "Name of social profile, profile name in social network" }, "about": { "type": "string", "description": "Account description, profile description in social network" }, "image": { "type": "object", "description": "Full image Url, avatar in social network", "properties": { "link": { "type": "string" } }, "required": [ "link" ] }, "social_id": { "type": "string", "description": "ID which using in social network" }, "social_profile_entity_type": { "description": "Type of \"Subprofile\" info", "$ref": "#\/components\/schemas\/SocialProfileEntityTypeResource" } }, "required": [ "id", "name", "about", "image", "social_id", "social_profile_entity_type" ], "title": "SocialProfileEntityResource" }, "SocialProfileEntityTypeResource": { "type": "object", "properties": { "name": { "type": "string", "description": "Type name of \"Subprofile\"" } }, "required": [ "name" ], "title": "SocialProfileEntityTypeResource" }, "SocialProfileResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "name": { "type": "string", "description": "Name of social profile, profile name in social network" }, "about": { "type": "string", "description": "Account description, profile description in social network" }, "network": { "description": "Network Info", "$ref": "#\/components\/schemas\/NetworkResource" }, "image": { "type": "object", "description": "Full image Url, avatar in social network", "properties": { "link": { "type": "string" } }, "required": [ "link" ] }, "social_id": { "type": "string", "description": "ID which using in social network" }, "identifier": { "type": "string", "description": "Identifier (mainly for Telegram channels - username or invite link)" }, "social_profile_entities": { "type": "array", "description": "\"Subprofiles\" Info", "items": { "$ref": "#\/components\/schemas\/SocialProfileEntityResource" } } }, "required": [ "id", "name", "about", "network", "image", "social_id", "identifier", "social_profile_entities" ], "title": "SocialProfileResource" }, "StoreMediaLibraryFolderRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "parent_id": { "type": [ "string", "null" ] } }, "required": [ "name" ], "title": "StoreMediaLibraryFolderRequest" }, "TimeslotResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "day_of_week": { "type": "string", "description": "Day of week" }, "time": { "type": "string", "description": "Time, format: H:i" }, "post_type": { "type": "string", "description": "Post type info if existed, otherwise null" }, "label": { "type": "string", "description": "The label of timeslot" }, "social_account_id": { "type": "string", "description": "Social Account ID" } }, "required": [ "id", "day_of_week", "time", "post_type", "label", "social_account_id" ], "title": "TimeslotResource" }, "UpdateMediaContentRequest": { "type": "object", "properties": { "label": { "type": [ "string", "null" ], "description": "Media Content Label to update. Optional", "maxLength": 250 }, "folder_id": { "type": [ "string", "null" ] } }, "title": "UpdateMediaContentRequest" }, "UpdateMediaLibraryFolderRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "parent_id": { "type": [ "string", "null" ] } }, "title": "UpdateMediaLibraryFolderRequest" }, "UserResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "state": { "description": "The current user state, includes active workspace. If existed, otherwise null", "anyOf": [ { "type": "object", "properties": { "workspace_id": { "type": "null" } }, "required": [ "workspace_id" ] }, { "type": "string" } ] }, "unread_notifications_count": { "type": "integer", "description": "The count of unread notifications" }, "avatar": { "type": "string", "description": "Full avatar url if existed, otherwise null" }, "time_format": { "type": "string", "description": "Time format. Possible values: 12, 24" }, "timezone": { "type": "string", "description": "User timezone. Default (UTC)" }, "name": { "type": "string", "description": "The name of user" }, "email": { "type": "string", "description": "The Email of user" }, "status": { "type": "string", "description": "Current user status uppercase for active workspace if active workspace existed. Default: ACTIVE. Possible values: ACTIVE, DISABLED, PENDING" }, "push_notifications_allowed": { "type": "boolean", "description": "Is it allowed to send notifications" }, "workspaces": { "type": "array", "description": "User Workspaces Info", "items": { "$ref": "#\/components\/schemas\/WorkspaceResource" } }, "role": { "description": "User role of active workspace", "$ref": "#\/components\/schemas\/RoleResource" }, "pivot": { "type": "object", "description": "Metadata from the pivot (access level and connection type), if available", "properties": { "access_level": { "type": "string", "description": "Access level of user to pivot" }, "connection_type": { "type": "string", "description": "Connection type of user to pivot" } }, "required": [ "access_level", "connection_type" ] }, "profiles": { "type": "array", "description": "User Profiles Info", "items": { "$ref": "#\/components\/schemas\/ProfileResource" } }, "permissions": { "type": "array", "description": "User Permissions Info", "items": { "$ref": "#\/components\/schemas\/PermissionResource" } }, "email_notification_settings": { "type": "string" } }, "required": [ "name", "email", "status", "push_notifications_allowed", "email_notification_settings" ], "title": "UserResource" }, "WorkspaceAnalyticsResource": { "type": "object", "properties": { "workspace_id": { "type": "string" }, "total": { "type": "object", "properties": { "comments": { "type": "string" }, "likes": { "type": "string" }, "shares": { "type": "string" }, "impressions": { "type": "string" }, "quotes": { "type": "string" }, "saves": { "type": "string" }, "engagement_rate": { "type": "string" } }, "required": [ "comments", "likes", "shares", "impressions", "quotes", "saves", "engagement_rate" ] } }, "required": [ "workspace_id", "total" ], "title": "WorkspaceAnalyticsResource" }, "WorkspaceResource": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "name": { "type": "string", "description": "Name" }, "avatar": { "type": [ "string", "null" ], "description": "Full url of avatar image if existed, otherwise null" } }, "required": [ "id", "name", "avatar" ], "title": "WorkspaceResource" } }, "responses": { "AuthenticationException": { "description": "Unauthenticated", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "AuthorizationException": { "description": "Authorization error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ModelNotFoundException": { "description": "Not found", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ValidationException": { "description": "Validation error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } } } } }