{
"openapi": "3.0.0",
"info": {
"version": "v1",
"title": "AuthoredUp API"
},
"servers": [
{
"url": "https://api.authoredup.com"
}
],
"paths": {
"/external/api/v1/posts": {
"get": {
"operationId": "getPosts",
"tags": [
"External"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDataQueryResult"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Query the user's own posts (including posts owned by their teammates for Business accounts).",
"parameters": [
{
"in": "query",
"name": "post-urn",
"required": false,
"description": "Pick individual posts by URN",
"schema": {
"type": "string",
"description": "Pick individual posts by URN"
}
},
{
"in": "query",
"name": "actors",
"required": false,
"description": "Filter list to a union of given actors",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter list to a union of given actors"
}
},
{
"in": "query",
"name": "from-date",
"required": false,
"description": "From which normalized date to start looking for posts. Provided as ISO 8601 date string.",
"schema": {
"type": "string",
"format": "date-time",
"description": "From which normalized date to start looking for posts. Provided as ISO 8601 date string."
}
},
{
"in": "query",
"name": "to-date",
"required": false,
"description": "To which normalized date to look for posts. Provided as ISO 8601 date string.",
"schema": {
"type": "string",
"format": "date-time",
"description": "To which normalized date to look for posts. Provided as ISO 8601 date string."
}
},
{
"in": "query",
"name": "content-types",
"required": false,
"description": "Only provide posts with given content types.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Image",
"Document",
"Text",
"Repost",
"Reshare",
"Article",
"LinkedInVideo",
"Poll",
"ExternalVideo",
"Event",
"Entity",
"ScheduledLiveContent",
"Celebration",
"Newsletter",
"Slideshow",
"TextOverlayImage",
"Showcase",
"Review",
"Other"
]
},
"description": "Only provide posts with given content types."
}
},
{
"in": "query",
"name": "tags",
"required": false,
"description": "List of user tags to filter posts by",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user tags to filter posts by"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"description": "Loose string to filter rows by",
"schema": {
"type": "string",
"description": "Loose string to filter rows by"
}
},
{
"in": "query",
"name": "sort-field",
"required": false,
"description": "Field to sort by (defaults to \"post_updated_at\")",
"schema": {
"type": "string",
"description": "Field to sort by (defaults to \"post_updated_at\")",
"enum": [
"urn",
"text",
"document",
"content_type",
"hashtags",
"images",
"actor_profile_id",
"actor_company_id",
"actor_group_id",
"text_metrics",
"time_zone_name",
"reaction_counts",
"reaction_count",
"comment_count",
"share_count",
"impression_count",
"did_self_like",
"text_attributes",
"post_scheduled_date",
"post_created_at",
"post_updated_at",
"post_published_at",
"post_deleted_at",
"engagement_rate",
"normalized_post_date",
"document.name",
"document.id",
"document.size_in_bytes",
"document.mime_type",
"document.recommended_extension",
"text_metrics.rawLength",
"text_metrics.characters",
"text_metrics.words",
"text_metrics.paragraphs",
"text_metrics.sentences",
"text_metrics.readingTimeMs",
"text_metrics.readabilityIndex",
"reaction_counts.LIKE",
"reaction_counts.INTEREST",
"reaction_counts.PRAISE",
"reaction_counts.EMPATHY",
"reaction_counts.ENTERTAINMENT",
"reaction_counts.APPRECIATION",
"reaction_counts.MAYBE"
]
}
},
{
"in": "query",
"name": "sort-direction",
"required": false,
"description": "Direction to sort by (defaults to \"desc\")",
"schema": {
"type": "string",
"description": "Direction to sort by (defaults to \"desc\")",
"enum": [
"asc",
"desc"
]
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "How many records to return (defaults to 20, max 1000)",
"schema": {
"type": "number",
"format": "float",
"description": "How many records to return (defaults to 20, max 1000)"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Start after this many items. Used for pagination",
"schema": {
"type": "number",
"format": "float",
"description": "Start after this many items. Used for pagination"
}
},
{
"in": "query",
"name": "include",
"required": false,
"description": "Include posts with given statuses\nIf not specified, defaults to \"published\" and \"scheduled\".",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"hidden",
"deleted",
"scheduled",
"published"
]
},
"description": "Include posts with given statuses\nIf not specified, defaults to \"published\" and \"scheduled\"."
}
}
],
"security": [
{
"bearer_user_token": []
}
]
}
},
"/external/api/v1/posts/{urn}": {
"get": {
"operationId": "getPost",
"tags": [
"External"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDataQueryResult"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Get an individual post data by URN. Returns the same query result as the query endpoint, but for a single post.",
"parameters": [
{
"in": "path",
"name": "urn",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearer_user_token": []
}
]
}
},
"/external/api/v1/saved-posts": {
"get": {
"operationId": "getSavedPosts",
"tags": [
"External"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDataQueryResult"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Query posts saved by user",
"parameters": [
{
"in": "query",
"name": "post-urn",
"required": false,
"description": "Pick individual posts by URN",
"schema": {
"type": "string",
"description": "Pick individual posts by URN"
}
},
{
"in": "query",
"name": "actors",
"required": false,
"description": "Filter list to a union of given actors",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter list to a union of given actors"
}
},
{
"in": "query",
"name": "from-date",
"required": false,
"description": "From which normalized date to start looking for posts. Provided as ISO 8601 date string.",
"schema": {
"type": "string",
"format": "date-time",
"description": "From which normalized date to start looking for posts. Provided as ISO 8601 date string."
}
},
{
"in": "query",
"name": "to-date",
"required": false,
"description": "To which normalized date to look for posts. Provided as ISO 8601 date string.",
"schema": {
"type": "string",
"format": "date-time",
"description": "To which normalized date to look for posts. Provided as ISO 8601 date string."
}
},
{
"in": "query",
"name": "content-types",
"required": false,
"description": "Only provide posts with given content types.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Image",
"Document",
"Text",
"Repost",
"Reshare",
"Article",
"LinkedInVideo",
"Poll",
"ExternalVideo",
"Event",
"Entity",
"ScheduledLiveContent",
"Celebration",
"Newsletter",
"Slideshow",
"TextOverlayImage",
"Showcase",
"Review",
"Other"
]
},
"description": "Only provide posts with given content types."
}
},
{
"in": "query",
"name": "tags",
"required": false,
"description": "List of user tags to filter posts by",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user tags to filter posts by"
}
},
{
"in": "query",
"name": "filter",
"required": false,
"description": "Loose string to filter rows by",
"schema": {
"type": "string",
"description": "Loose string to filter rows by"
}
},
{
"in": "query",
"name": "sort-field",
"required": false,
"description": "Field to sort by (defaults to \"post_updated_at\")",
"schema": {
"type": "string",
"description": "Field to sort by (defaults to \"post_updated_at\")",
"enum": [
"urn",
"text",
"document",
"content_type",
"hashtags",
"images",
"actor_profile_id",
"actor_company_id",
"actor_group_id",
"text_metrics",
"time_zone_name",
"reaction_counts",
"reaction_count",
"comment_count",
"share_count",
"impression_count",
"did_self_like",
"text_attributes",
"post_scheduled_date",
"post_created_at",
"post_updated_at",
"post_published_at",
"post_deleted_at",
"engagement_rate",
"normalized_post_date",
"document.name",
"document.id",
"document.size_in_bytes",
"document.mime_type",
"document.recommended_extension",
"text_metrics.rawLength",
"text_metrics.characters",
"text_metrics.words",
"text_metrics.paragraphs",
"text_metrics.sentences",
"text_metrics.readingTimeMs",
"text_metrics.readabilityIndex",
"reaction_counts.LIKE",
"reaction_counts.INTEREST",
"reaction_counts.PRAISE",
"reaction_counts.EMPATHY",
"reaction_counts.ENTERTAINMENT",
"reaction_counts.APPRECIATION",
"reaction_counts.MAYBE"
]
}
},
{
"in": "query",
"name": "sort-direction",
"required": false,
"description": "Direction to sort by (defaults to \"desc\")",
"schema": {
"type": "string",
"description": "Direction to sort by (defaults to \"desc\")",
"enum": [
"asc",
"desc"
]
}
},
{
"in": "query",
"name": "limit",
"required": false,
"description": "How many records to return (defaults to 20, max 1000)",
"schema": {
"type": "number",
"format": "float",
"description": "How many records to return (defaults to 20, max 1000)"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"description": "Start after this many items. Used for pagination",
"schema": {
"type": "number",
"format": "float",
"description": "Start after this many items. Used for pagination"
}
},
{
"in": "query",
"name": "profile-ids",
"required": false,
"description": "List of the profiles for which to seek saved posts",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of the profiles for which to seek saved posts"
}
},
{
"in": "query",
"name": "include-hidden",
"required": false,
"description": "If true, also return posts that are hidden from the saved list",
"schema": {
"type": "boolean",
"description": "If true, also return posts that are hidden from the saved list"
}
}
],
"security": [
{
"bearer_user_token": []
}
]
}
},
"/external/api/v1/saved-posts/{urn}": {
"get": {
"operationId": "getSavedPost",
"tags": [
"External"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDataQueryResult"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Get saved post by URN",
"parameters": [
{
"in": "path",
"name": "urn",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearer_user_token": []
}
]
}
},
"/external/api/v1/actors": {
"get": {
"operationId": "getActors",
"tags": [
"External"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Actor"
}
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "List available actors",
"parameters": [
{
"in": "query",
"name": "include-types",
"required": false,
"description": "Filter actors by type, by default all types are included",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"profile",
"company",
"group"
]
},
"description": "Filter actors by type, by default all types are included"
}
}
],
"security": [
{
"bearer_user_token": []
}
]
}
},
"/external/api/v1/dashboard/{profileId}/profile-history": {
"get": {
"operationId": "getDashboardProfileHistory",
"tags": [
"External"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardProfileHistory"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "List historic performance data for one of your profiles. This data is used in AuthoredUp's profile dashboard, and includes follower and connection counts.",
"parameters": [
{
"in": "path",
"name": "profileId",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "period",
"required": false,
"description": "Time period for profile history",
"schema": {
"type": "string",
"description": "Time period for profile history",
"default": "month",
"enum": [
"month",
"quarter",
"year"
]
}
}
],
"security": [
{
"bearer_user_token": []
}
]
}
},
"/external/api/v1/dashboard/{companyId}/company-history": {
"get": {
"operationId": "getDashboardCompanyHistory",
"tags": [
"External"
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardCompanyHistory"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "List company page's performance data points (followers). This data is used in AuthoredUp's company dashboard.",
"parameters": [
{
"in": "path",
"name": "companyId",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "period",
"required": false,
"description": "Time period for profile history",
"schema": {
"type": "string",
"description": "Time period for profile history",
"default": "month",
"enum": [
"month",
"quarter",
"year"
]
}
}
],
"security": [
{
"bearer_user_token": []
}
]
}
},
"/external/api/v1/images/{id}/data": {
"get": {
"operationId": "getImageData",
"tags": [
"External"
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Get image data (download/display image) for given id. Note that the response might involve a 302 redirect.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearer_user_token": []
}
]
}
},
"/external/api/v1/documents/{id}/data": {
"get": {
"operationId": "getDocumentData",
"tags": [
"External"
],
"responses": {
"200": {
"description": "Success"
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"description": "Download document for given id. Note that the response might involve a 302 redirect.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"bearer_user_token": []
}
]
}
}
},
"components": {
"schemas": {
"Error": {
"description": "Custom error message",
"required": [
"status",
"message",
"name"
],
"properties": {
"status": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"data": {
"type": "object",
"additionalProperties": true,
"description": "Additional data about the error, if available"
}
}
},
"ValidationError": {
"description": "Validation error",
"required": [
"status",
"message",
"name",
"data"
],
"properties": {
"status": {
"type": "integer",
"format": "int32",
"example": 400
},
"message": {
"type": "string",
"example": "Validation error: \"content-types[0]\" must be one of [Image, Document, Text, ...]"
},
"name": {
"type": "string",
"example": "ValidationError"
},
"data": {
"type": "object",
"properties": {
"faults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"path": {
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"type": {
"type": "string"
},
"context": {
"type": "object",
"additionalProperties": true
}
}
}
},
"target": {
"type": "object",
"additionalProperties": true
},
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"PostDataCriteria": {
"type": "object",
"properties": {
"post-urn": {
"type": "string",
"description": "Pick individual posts by URN"
},
"actors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter list to a union of given actors"
},
"from-date": {
"type": "string",
"format": "date-time",
"description": "From which normalized date to start looking for posts. Provided as ISO 8601 date string."
},
"to-date": {
"type": "string",
"format": "date-time",
"description": "To which normalized date to look for posts. Provided as ISO 8601 date string."
},
"content-types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Image",
"Document",
"Text",
"Repost",
"Reshare",
"Article",
"LinkedInVideo",
"Poll",
"ExternalVideo",
"Event",
"Entity",
"ScheduledLiveContent",
"Celebration",
"Newsletter",
"Slideshow",
"TextOverlayImage",
"Showcase",
"Review",
"Other"
]
},
"description": "Only provide posts with given content types."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user tags to filter posts by"
},
"filter": {
"type": "string",
"description": "Loose string to filter rows by"
},
"sort-field": {
"type": "string",
"description": "Field to sort by (defaults to \"post_updated_at\")",
"enum": [
"urn",
"text",
"document",
"content_type",
"hashtags",
"images",
"actor_profile_id",
"actor_company_id",
"actor_group_id",
"text_metrics",
"time_zone_name",
"reaction_counts",
"reaction_count",
"comment_count",
"share_count",
"impression_count",
"did_self_like",
"text_attributes",
"post_scheduled_date",
"post_created_at",
"post_updated_at",
"post_published_at",
"post_deleted_at",
"engagement_rate",
"normalized_post_date",
"document.name",
"document.id",
"document.size_in_bytes",
"document.mime_type",
"document.recommended_extension",
"text_metrics.rawLength",
"text_metrics.characters",
"text_metrics.words",
"text_metrics.paragraphs",
"text_metrics.sentences",
"text_metrics.readingTimeMs",
"text_metrics.readabilityIndex",
"reaction_counts.LIKE",
"reaction_counts.INTEREST",
"reaction_counts.PRAISE",
"reaction_counts.EMPATHY",
"reaction_counts.ENTERTAINMENT",
"reaction_counts.APPRECIATION",
"reaction_counts.MAYBE"
]
},
"sort-direction": {
"type": "string",
"description": "Direction to sort by (defaults to \"desc\")",
"enum": [
"asc",
"desc"
]
},
"limit": {
"type": "number",
"format": "float",
"description": "How many records to return (defaults to 20, max 1000)"
},
"offset": {
"type": "number",
"format": "float",
"description": "Start after this many items. Used for pagination"
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"hidden",
"deleted",
"scheduled",
"published"
]
},
"description": "Include posts with given statuses\nIf not specified, defaults to \"published\" and \"scheduled\"."
}
},
"additionalProperties": false
},
"PostDataQueryResult": {
"type": "object",
"properties": {
"nextPageOffset": {
"type": "number",
"format": "float",
"description": "What offset should be set to grab the next page. If there are no more records, this will be null"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"urn": {
"oneOf": [
{
"type": "array"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object",
"additionalProperties": true
},
{
"type": "string"
}
]
},
"text": {
"type": "string",
"nullable": true
},
"text_attributes": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"start": {
"type": "number",
"format": "float"
},
"length": {
"type": "number",
"format": "float"
},
"index": {
"type": "number",
"format": "float"
},
"type": {
"type": "string"
},
"urnValue": {
"type": "string"
}
},
"required": [
"start",
"length",
"index",
"type",
"urnValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"format": "float"
},
"length": {
"type": "number",
"format": "float"
},
"index": {
"type": "number",
"format": "float"
},
"type": {
"type": "string"
},
"urnValue": {
"type": "string"
},
"numericId": {
"type": "number",
"format": "float",
"description": "Available only for some sources. It seems we can regenerate a mention without it."
}
},
"required": [
"start",
"length",
"index",
"type",
"urnValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"format": "float"
},
"length": {
"type": "number",
"format": "float"
},
"index": {
"type": "number",
"format": "float"
},
"type": {
"type": "string"
},
"hashtag": {
"type": "string"
}
},
"required": [
"start",
"length",
"index",
"type",
"hashtag"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"format": "float"
},
"length": {
"type": "number",
"format": "float"
},
"index": {
"type": "number",
"format": "float"
},
"type": {
"type": "string"
},
"rawLink": {
"type": "string"
},
"resolvedLink": {
"type": "string"
},
"linkType": {
"type": "string",
"enum": [
"external",
"internal",
"email"
]
}
},
"required": [
"start",
"length",
"index",
"type",
"rawLink",
"resolvedLink",
"linkType"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"start": {
"type": "number",
"format": "float"
},
"length": {
"type": "number",
"format": "float"
},
"index": {
"type": "number",
"format": "float"
},
"type": {
"type": "string"
},
"font": {
"type": "string",
"nullable": true,
"enum": [
"bold",
"italic",
"boldItalic",
"monospace"
]
},
"styling": {
"type": "array",
"items": {
"type": "string",
"enum": [
"strikethrough",
"underline"
]
},
"nullable": true
}
},
"required": [
"start",
"length",
"index",
"type",
"font",
"styling"
],
"additionalProperties": false
}
]
},
"nullable": true
},
"content_type": {
"type": "string",
"description": "Note that LinkedInVideo and ExternalVideo distinction isn't entirely reliable.",
"enum": [
"Image",
"Document",
"Text",
"Repost",
"Reshare",
"Article",
"LinkedInVideo",
"Poll",
"ExternalVideo",
"Event",
"Entity",
"ScheduledLiveContent",
"Celebration",
"Newsletter",
"Slideshow",
"TextOverlayImage",
"Showcase",
"Review",
"Other"
]
},
"hashtags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hashtag": {
"type": "string"
},
"count": {
"type": "number",
"format": "float"
}
},
"required": [
"hashtag",
"count"
],
"additionalProperties": false
}
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number",
"format": "float"
},
"width": {
"type": "number",
"format": "float"
},
"height": {
"type": "number",
"format": "float"
}
},
"required": [
"id",
"original_name",
"format",
"size_in_bytes",
"width",
"height"
],
"additionalProperties": false
},
"description": "List of images for image posts. List of page screenshots for document posts (if available)."
},
"document": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true,
"description": "This maps to file name, including extension"
},
"id": {
"type": "string"
},
"size_in_bytes": {
"type": "number",
"format": "float"
},
"mime_type": {
"type": "string"
},
"recommended_extension": {
"type": "string",
"description": "This is based on the original document file name or its mime type."
}
},
"required": [
"name",
"id",
"size_in_bytes",
"mime_type",
"recommended_extension"
],
"additionalProperties": false,
"description": "For document posts, this is the document that was attached to the post (likely PDF)."
},
"actor_profile_id": {
"type": "string",
"nullable": true
},
"actor_company_id": {
"type": "string",
"nullable": true
},
"actor_group_id": {
"type": "string",
"nullable": true
},
"text_metrics": {
"type": "object",
"properties": {
"rawLength": {
"type": "number",
"format": "float"
},
"characters": {
"type": "number",
"format": "float"
},
"words": {
"type": "number",
"format": "float"
},
"paragraphs": {
"type": "number",
"format": "float"
},
"sentences": {
"type": "number",
"format": "float"
},
"readingTimeMs": {
"type": "number",
"format": "float"
},
"readabilityIndex": {
"type": "number",
"format": "float"
}
},
"required": [
"rawLength",
"characters",
"words",
"paragraphs",
"sentences",
"readingTimeMs",
"readabilityIndex"
],
"additionalProperties": false,
"nullable": true
},
"time_zone_name": {
"type": "string",
"nullable": true,
"description": "Not available for posts that were published without AuthoredUp.\nInternally, for those posts we fall back to the post author's time zone."
},
"reaction_counts": {
"type": "object",
"additionalProperties": true
},
"reaction_count": {
"type": "number",
"format": "float",
"nullable": true
},
"comment_count": {
"type": "number",
"format": "float",
"nullable": true
},
"share_count": {
"type": "number",
"format": "float",
"nullable": true
},
"impression_count": {
"type": "number",
"format": "float",
"nullable": true
},
"engagement_rate": {
"type": "number",
"format": "float",
"description": "Calculated as: reactions + comments + shares / impressions\nOnly available if all the data is available."
},
"did_self_like": {
"type": "boolean",
"nullable": true
},
"post_scheduled_date": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "This is the date the post has been scheduled for publishing. It will stay set even after the post has been published.\nWe won't have this data for posts that were published without AuthoredUp."
},
"post_created_at": {
"type": "string",
"format": "date-time",
"description": "This data is correct for posts that were created with AuthoredUp, and estimated for others."
},
"post_updated_at": {
"type": "string",
"format": "date-time",
"description": "We can precisely tell when this happens if you use AuthoredUp. Otherwise, we estimate it the best we can."
},
"post_published_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "This data can be accurately estimated from the data provided by LinkedIn, so you can rely on it pretty confidently."
},
"post_deleted_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "If we've detected the post has been deleted, this will be set to the date of deletion."
},
"normalized_post_date": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Date that is derived from the deleted, published, scheduled or created date, in that order of priority.\nYou should be able to rely that you always have this date."
}
},
"required": [
"urn",
"text",
"text_attributes",
"content_type",
"hashtags",
"actor_profile_id",
"actor_company_id",
"actor_group_id",
"text_metrics",
"time_zone_name",
"reaction_counts",
"reaction_count",
"comment_count",
"share_count",
"impression_count",
"engagement_rate",
"did_self_like",
"post_scheduled_date",
"post_created_at",
"post_updated_at",
"post_published_at",
"post_deleted_at",
"normalized_post_date"
],
"additionalProperties": false
},
"description": "List of posts that match the criteria."
},
"profiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"maiden_name": {
"type": "string",
"description": "This can also be the middle name, or a second first name (LinkedIn has renamed it in UI)"
},
"last_name": {
"type": "string"
},
"occupation": {
"type": "string",
"description": "Profile tagline"
},
"public_identifier": {
"type": "string",
"description": "This can be used to link to the profile on LinkedIn. Eg. https://www.linkedin.com/in/{identifier}"
},
"follower_count": {
"type": "number",
"format": "float",
"description": "The latest follower count for the profile"
},
"connection_count": {
"type": "number",
"format": "float",
"description": "The latest connection count for the profile"
},
"picture": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number",
"format": "float"
},
"width": {
"type": "number",
"format": "float"
},
"height": {
"type": "number",
"format": "float"
}
},
"required": [
"id",
"original_name",
"format",
"size_in_bytes",
"width",
"height"
],
"additionalProperties": false
},
"background_image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number",
"format": "float"
},
"width": {
"type": "number",
"format": "float"
},
"height": {
"type": "number",
"format": "float"
}
},
"required": [
"id",
"original_name",
"format",
"size_in_bytes",
"width",
"height"
],
"additionalProperties": false
}
},
"required": [
"id",
"first_name",
"maiden_name",
"last_name",
"occupation",
"public_identifier",
"follower_count",
"connection_count",
"picture",
"background_image"
],
"additionalProperties": false
},
"description": "All referenced actor profiles"
},
"companies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"universal_name": {
"type": "string",
"description": "Universal name is a unique identifier for the company, used in URLs"
},
"url": {
"type": "string",
"description": "Direct URL to the company page on LinkedIn"
},
"is_school": {
"type": "boolean",
"description": "Indicates if the company is a school or university"
},
"is_stub": {
"type": "boolean",
"description": "Indicates that we never received all the data about this company. Treat with caution."
},
"follower_count": {
"type": "number",
"format": "float"
},
"logo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number",
"format": "float"
},
"width": {
"type": "number",
"format": "float"
},
"height": {
"type": "number",
"format": "float"
}
},
"required": [
"id",
"original_name",
"format",
"size_in_bytes",
"width",
"height"
],
"additionalProperties": false
},
"cover_image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number",
"format": "float"
},
"width": {
"type": "number",
"format": "float"
},
"height": {
"type": "number",
"format": "float"
}
},
"required": [
"id",
"original_name",
"format",
"size_in_bytes",
"width",
"height"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"universal_name",
"url",
"is_school",
"is_stub",
"follower_count",
"logo",
"cover_image"
],
"additionalProperties": false
},
"description": "All referenced actor companies"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_public": {
"type": "boolean"
},
"is_stub": {
"type": "boolean",
"description": "Indicates that we never received all the data about this group. Treat with caution."
},
"logo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number",
"format": "float"
},
"width": {
"type": "number",
"format": "float"
},
"height": {
"type": "number",
"format": "float"
}
},
"required": [
"id",
"original_name",
"format",
"size_in_bytes",
"width",
"height"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"description",
"is_public",
"is_stub",
"logo"
],
"additionalProperties": false
},
"description": "All referenced actor groups"
}
},
"required": [
"nextPageOffset",
"items",
"profiles",
"companies",
"groups"
],
"additionalProperties": false
},
"SavedPostDataCriteria": {
"type": "object",
"properties": {
"post-urn": {
"type": "string",
"description": "Pick individual posts by URN"
},
"actors": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter list to a union of given actors"
},
"from-date": {
"type": "string",
"format": "date-time",
"description": "From which normalized date to start looking for posts. Provided as ISO 8601 date string."
},
"to-date": {
"type": "string",
"format": "date-time",
"description": "To which normalized date to look for posts. Provided as ISO 8601 date string."
},
"content-types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Image",
"Document",
"Text",
"Repost",
"Reshare",
"Article",
"LinkedInVideo",
"Poll",
"ExternalVideo",
"Event",
"Entity",
"ScheduledLiveContent",
"Celebration",
"Newsletter",
"Slideshow",
"TextOverlayImage",
"Showcase",
"Review",
"Other"
]
},
"description": "Only provide posts with given content types."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user tags to filter posts by"
},
"filter": {
"type": "string",
"description": "Loose string to filter rows by"
},
"sort-field": {
"type": "string",
"description": "Field to sort by (defaults to \"post_updated_at\")",
"enum": [
"urn",
"text",
"document",
"content_type",
"hashtags",
"images",
"actor_profile_id",
"actor_company_id",
"actor_group_id",
"text_metrics",
"time_zone_name",
"reaction_counts",
"reaction_count",
"comment_count",
"share_count",
"impression_count",
"did_self_like",
"text_attributes",
"post_scheduled_date",
"post_created_at",
"post_updated_at",
"post_published_at",
"post_deleted_at",
"engagement_rate",
"normalized_post_date",
"document.name",
"document.id",
"document.size_in_bytes",
"document.mime_type",
"document.recommended_extension",
"text_metrics.rawLength",
"text_metrics.characters",
"text_metrics.words",
"text_metrics.paragraphs",
"text_metrics.sentences",
"text_metrics.readingTimeMs",
"text_metrics.readabilityIndex",
"reaction_counts.LIKE",
"reaction_counts.INTEREST",
"reaction_counts.PRAISE",
"reaction_counts.EMPATHY",
"reaction_counts.ENTERTAINMENT",
"reaction_counts.APPRECIATION",
"reaction_counts.MAYBE"
]
},
"sort-direction": {
"type": "string",
"description": "Direction to sort by (defaults to \"desc\")",
"enum": [
"asc",
"desc"
]
},
"limit": {
"type": "number",
"format": "float",
"description": "How many records to return (defaults to 20, max 1000)"
},
"offset": {
"type": "number",
"format": "float",
"description": "Start after this many items. Used for pagination"
},
"profile-ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of the profiles for which to seek saved posts"
},
"include-hidden": {
"type": "boolean",
"description": "If true, also return posts that are hidden from the saved list"
}
},
"additionalProperties": false
},
"Actor": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "For profiles, this is the profile ID (LNP_abcdef).\nFor companies, this is the company ID (LNC_abcdef).\nFor groups, this is the combination of a profile ID and group's numeric ID, separated by a \".\" (dot).\n For example: \"LNP_abcdef.123\""
},
"type": {
"type": "string",
"description": "The type of this actor. One of \"profile\", \"company\" or \"group\".",
"enum": [
"profile",
"company",
"group"
]
},
"profile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"maiden_name": {
"type": "string",
"description": "This can also be the middle name, or a second first name (LinkedIn has renamed it in UI)"
},
"last_name": {
"type": "string"
},
"occupation": {
"type": "string",
"description": "Profile tagline"
},
"public_identifier": {
"type": "string",
"description": "This can be used to link to the profile on LinkedIn. Eg. https://www.linkedin.com/in/{identifier}"
},
"follower_count": {
"type": "number",
"format": "float",
"description": "The latest follower count for the profile"
},
"connection_count": {
"type": "number",
"format": "float",
"description": "The latest connection count for the profile"
},
"picture": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number",
"format": "float"
},
"width": {
"type": "number",
"format": "float"
},
"height": {
"type": "number",
"format": "float"
}
},
"required": [
"id",
"original_name",
"format",
"size_in_bytes",
"width",
"height"
],
"additionalProperties": false
},
"background_image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number",
"format": "float"
},
"width": {
"type": "number",
"format": "float"
},
"height": {
"type": "number",
"format": "float"
}
},
"required": [
"id",
"original_name",
"format",
"size_in_bytes",
"width",
"height"
],
"additionalProperties": false
}
},
"required": [
"id",
"first_name",
"maiden_name",
"last_name",
"occupation",
"public_identifier",
"follower_count",
"connection_count",
"picture",
"background_image"
],
"additionalProperties": false,
"description": "Present for profile and group actors."
},
"company": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"universal_name": {
"type": "string",
"description": "Universal name is a unique identifier for the company, used in URLs"
},
"url": {
"type": "string",
"description": "Direct URL to the company page on LinkedIn"
},
"is_school": {
"type": "boolean",
"description": "Indicates if the company is a school or university"
},
"is_stub": {
"type": "boolean",
"description": "Indicates that we never received all the data about this company. Treat with caution."
},
"follower_count": {
"type": "number",
"format": "float"
},
"logo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number",
"format": "float"
},
"width": {
"type": "number",
"format": "float"
},
"height": {
"type": "number",
"format": "float"
}
},
"required": [
"id",
"original_name",
"format",
"size_in_bytes",
"width",
"height"
],
"additionalProperties": false
},
"cover_image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number",
"format": "float"
},
"width": {
"type": "number",
"format": "float"
},
"height": {
"type": "number",
"format": "float"
}
},
"required": [
"id",
"original_name",
"format",
"size_in_bytes",
"width",
"height"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"universal_name",
"url",
"is_school",
"is_stub",
"follower_count",
"logo",
"cover_image"
],
"additionalProperties": false,
"description": "Present for company actors."
},
"group": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_public": {
"type": "boolean"
},
"is_stub": {
"type": "boolean",
"description": "Indicates that we never received all the data about this group. Treat with caution."
},
"logo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"original_name": {
"type": "string",
"description": "The original name of the image, including extension"
},
"format": {
"type": "string",
"description": "The format of the image, eg. \"jpg\", \"png\""
},
"size_in_bytes": {
"type": "number",
"format": "float"
},
"width": {
"type": "number",
"format": "float"
},
"height": {
"type": "number",
"format": "float"
}
},
"required": [
"id",
"original_name",
"format",
"size_in_bytes",
"width",
"height"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"description",
"is_public",
"is_stub",
"logo"
],
"additionalProperties": false,
"description": "Present for group actors."
}
},
"required": [
"identifier",
"type"
],
"additionalProperties": false
},
"DashboardProfileHistory": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"follower_count": {
"type": "number",
"format": "float",
"nullable": true
},
"connection_count": {
"type": "number",
"format": "float",
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"estimated": {
"type": "boolean",
"description": "If true, this data point was estimated based on the collected history and other data points.\nSince LinkedIn doesn't provide precise follower counts for past dates, this is the best we can do."
}
},
"required": [
"follower_count",
"connection_count",
"date",
"estimated"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
},
"DashboardCompanyHistory": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"follower_count": {
"type": "number",
"format": "float",
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
}
},
"required": [
"follower_count",
"date"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
}
},
"securitySchemes": {
"bearer_user_token": {
"type": "http",
"scheme": "bearer",
"name": "user_token",
"description": "Bearer token mechanism: \"user_token\""
}
}
}
}