Interface OpenApiComponents
interface OpenApiComponents {
headers: never;
parameters: {
AiPlansfromDate: string;
AiPlansidAiPlan: string;
AiPlansidClient: string;
AiPlansidOrganization: string;
AiPlanstoDate: string;
AppsidApp: string;
AppsidClient: string;
Appslimit: number;
Appsoffset: number;
CommentsidAccount: string;
CommentsidComment: string;
CommentsidOrganization: string;
CommentsidPublication: string;
CommentsthreadLimit: number;
CommentsthreadOffset: string;
ContactsidContact: string;
ContactsidOrganization: string;
Contactslimit: number;
Contactsoffset: number;
DashboardfromDate: string;
DashboardidOrganization: string;
DashboardtoDate: string;
IntegrationsidIntegration: string;
IntegrationsidOrganization: string;
MessagesfromDate: string;
MessagesgroupBy: "day" | "month" | "year";
MessagesidAccount: string;
MessagesidContact: string;
MessagesidOrganization: string;
Messageslimit: number;
Messagesoffset: number;
MessagestoDate: string;
OrganizationsRolesidOrganization: string;
OrganizationsRolesidRol: string;
OrganizationsRolesidUser: string;
OrganizationsRoleslimit: number;
OrganizationsRolesoffset: number;
ProductsidAccount: string;
ProductsidOrganization: string;
Productslimit: number;
Productsoffset: number;
};
pathItems: never;
requestBodies: never;
responses: {
AppsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
CommentsCommentError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
ContactsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
DashboardError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
MessagesError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
ProductsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
};
schemas: {
Account: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
AccountsAccountList: {
accounts: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}[];
total: number;
};
AccountsAccountOne: {
account: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
};
AccountsConnectSession: {
_id: string;
accounts: (
{
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
} & { already_enabled: boolean }
)[];
accounts_limit: number;
accounts_used: number;
creation_date?: string;
expires_at: string;
id_client?: string;
id_organization?: string;
keycloak_client_idenfifier?: string;
redirect_uri?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
status: "pending"
| "returned"
| "confirmed";
};
AccountsConnectSessionAccount: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
} & { already_enabled: boolean };
AccountsMetricList: (
| "reach"
| "impressions"
| "comments"
| "likes"
| "shares"
| "saves"
| "profile_views"
| "page_impressions"
| "page_total_actions"
| "page_call_phone_clicks_logged_in_unique"
| "page_get_directions_clicks_logged_in_unique"
| "page_website_clicks_logged_in_unique"
| "page_post_engagements"
| "page_consumptions_unique"
| "page_negative_feedback"
| "page_negative_feedback_unique"
| "page_fans_online_per_day"
| "page_impressions_unique"
| "page_impressions_paid"
| "page_impressions_paid_unique"
| "page_impressions_organic_v2"
| "page_impressions_organic_unique_v2"
| "page_impressions_viral"
| "page_impressions_viral_unique"
| "page_impressions_nonviral"
| "page_impressions_nonviral_unique"
| "page_posts_impressions"
| "page_posts_impressions_unique"
| "page_posts_impressions_paid"
| "page_posts_impressions_paid_unique"
| "page_posts_impressions_organic"
| "page_posts_impressions_organic_unique"
| "page_posts_served_impressions_organic_unique"
| "page_posts_impressions_viral"
| "page_posts_impressions_viral_unique"
| "page_posts_impressions_nonviral"
| "page_posts_impressions_nonviral_unique"
| "total_interactions"
| "accounts_engaged"
| "replies"
| "follows_and_unfollows"
| "profile_links_taps"
| "website_clicks"
| "paidFollowers"
| "organicFollowerGain"
| "careersPageBannerPromoClicks"
| "careersPagePromoLinksClicks"
| "careersPageEmployeesClicks"
| "careersPageJobsClicks"
| "careersPageViewsUnique"
| "careersPageViews"
| "overviewPageViewsUnique"
| "overviewPageViews"
| "allPageViews"
| "follows"
| "share"
| "views"
)[];
AccountsMetricModel: {
group: "day"
| "month"
| "year";
stats: {
date: string;
group: "day" | "month" | "year";
group_value: number;
name: string;
value: number;
}[];
};
AccountsPersistentMenu: {
call_to_actions?: { [key: string]: unknown }[];
composer_input_disabled?: boolean;
locale?: string;
}[];
AccountsSocialAuthorizationMethod: {
add_to_group_link?: string;
app_id?: string;
bot_username?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
state?: string;
type: "telegram_bot"
| "redirect"
| "meta_embedded_signup";
};
AccountsSocialLinksList: {
links: {
authorization: {
add_to_group_link?: string;
app_id?: string;
bot_username?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
state?: string;
type: "telegram_bot"
| "redirect"
| "meta_embedded_signup";
};
link: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
};
AiContext: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
AiImageOrigin: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
AiPlanResult: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
};
AiPlanResultsGroup: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
};
AiPlansAiPlan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: (...)
| (...)
| (...) } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
AiPlansAiPlanCostEstimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
AiPlansAiPlanCreateRequest: {
accounts: string[];
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
options?: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
link?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
prompt: string;
source?: {
event_date?: string;
event_name?: string;
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description: string; id_upload: string }[];
product_catalog_id?: string;
products?: string[];
text?: string;
url?: string;
};
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
};
AiPlansAiPlanCreateResponse: {
ai_plan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
estimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
estimated_cost: number;
};
AiPlansAiPlanDestination: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
};
AiPlansAiPlanList: {
ai_plans: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: ...;
id_ai_plan?: ...;
model: ...;
provider: ...;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: ...;
external_url: ...;
social_network: ...;
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: (...)[];
aspect_ratio: { text: ...; value: ... };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: (...) & (...);
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: ...]: ... };
deadline?: string;
next_check?: string;
temp_keys?: (...)[];
};
publication_errors: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: ...]: ... };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
}[];
total: number;
};
AiPlansAiPlanNotice: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
AiPlansAiPlanOne: {
ai_plan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
};
AiPlansAiPlanOptions: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
AiPlansAiPlanOptionsInput: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
link?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
AiPlansAiPlanResults: {
ai_plans: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[];
by_template: (
{
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
} & {
template: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
}
)[];
range: {
from_date: string;
previous_from_date?: string;
previous_to_date?: string;
to_date: string;
};
sort: string;
total: number;
totals: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
};
};
AiPlansAiPlanResultsTemplateGroup: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
} & {
template: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
};
AiPlansAiPlanSource: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
AiPlansAiPlanSourceImageInput: { description: string; id_upload: string };
AiPlansAiPlanSourceInput: {
event_date?: string;
event_name?: string;
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description: string; id_upload: string }[];
product_catalog_id?: string;
products?: string[];
text?: string;
url?: string;
};
AiPlansAiPlanSourceProduct: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
};
AppsClientApp: {
_id: string;
allowed_domains: string[];
creation_date: string;
deleted: boolean;
deleted_date?: string;
id_client: string;
id_user?: string;
keycloak_client_idenfifier: string;
name: string;
redirect_urls: string[];
webhook_url?: string;
};
AppsClientAppInput: {
allowed_domains?: string[];
keycloak_client_idenfifier: string;
name: string;
redirect_urls?: string[];
webhook_url?: string;
};
AppsOAuthError: {
error: | "server_error"
| "invalid_client"
| "slow_down"
| "invalid_request"
| "unsupported_grant_type";
error_description?: string;
};
AppsTokenRequest: {
client_id?: string;
client_secret?: string;
grant_type: "client_credentials";
scope?: string;
};
AppsTokenResponse: {
access_token: string;
expires_in: number;
scope?: string;
token_type: string;
};
CatalogAspectRatios: { text: string[]; values: number[] };
CatalogPlannerTemplate: {
allows_gallery?: boolean;
allows_shared?: boolean;
generates_images?: boolean;
max_source_items?: number;
orchestration_cost?: number;
orchestration_cost_per_source_item?: number;
regenerate?: { image?: boolean; text?: boolean };
source_fields?: {
default?: unknown;
max?: number;
min?: number;
name?: string;
options?: string[];
required?: boolean;
type?:
| "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "date"
| "uploads_with_description"
| "catalog_products";
}[];
source_requires_any?: string[];
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
unsupported_networks?: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
};
CatalogPlannerTemplateField: {
default?: unknown;
max?: number;
min?: number;
name?: string;
options?: string[];
required?: boolean;
type?: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "date"
| "uploads_with_description"
| "catalog_products";
};
CatalogSocialLimits: {
characters: { [key: string]: number };
comment_characters: { [key: string]: number };
max_file_size_mb: { [key: string]: number };
max_post_bytes: { [key: string]: number };
title_characters: { [key: string]: number };
total_images: { [key: string]: number };
video_duration_in_seconds: { [key: string]: number };
};
CatalogSocialLimitsMap: { [key: string]: number };
ClientsAiScopeSetting: {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter" | "openai" | "google" | "anthropic";
};
ClientsAiSettings: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
ClientsClient: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
};
ClientsClientList: {
clients: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
}[];
total: number;
};
ClientsClientOne: {
client: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
};
};
ClientsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
name: string;
};
ClientsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}[];
total: number;
};
ClientsOrganizationOne: {
organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
};
ClientsOrganizationUpdate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
stats_settings?: { auto_refresh_twitter: boolean };
};
ClientsPlan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
ClientsRolesClientPermissions: | "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read";
ClientsRolesClientPermissionsList: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
ClientsRolesClientPermissionsOne: {
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
ClientsRolesRole: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
ClientsRolesRoleInput: {
name: string;
permissions: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
| "client_organization_products:create"
| "client_organization_products:update"
| "client_organization_products:read"
| "client_organization_products:delete"
| "client_organization_messages:create"
| "client_organization_messages:read"
| "client_organization_messages:delete"
| "client_organization_contacts:create"
| "client_organization_contacts:read"
| "client_organization_contacts:update"
| "client_organization_contacts:delete"
| "client_organization_ai_plans:create"
| "client_organization_ai_plans:read"
| "client_organization_ai_plans:update"
| "client_organization_ai_plans:delete"
)[];
};
ClientsRolesRoleList: {
roles?: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
}[];
total?: number;
};
ClientsRolesRoleOne: {
rol?: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
};
ClientsRolesUser: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
};
ClientsRolesUserList: {
total?: number;
users?: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
}[];
};
CommentsAiPlanWebhookChange: {
credits_spent: number;
error?: { code: number; message: string };
field: "ai_plan_generated" | "ai_plan_failed";
id_ai_plan: string;
id_organization: string;
state: "generated" | "failed";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
total_publications: number;
warnings: number;
};
CommentsAiPlanWebhookError: { code: number; message: string };
CommentsComment: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
};
CommentsCommentActions: {
delete_others: boolean;
delete_own: boolean;
hide: boolean;
reply: boolean;
};
CommentsCommentAuthor: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
CommentsCommentNetworkName: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
CommentsCommentThread: {
comments: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
}[];
credits_consumed: number;
next_cursor?: string;
total: number;
};
CommentsIntegrationWebhookChange: {
error_code: number;
field: "integration_error";
id_integration: string;
id_organization: string;
provider: string;
};
CommentsSocialCapabilities: {
comments: boolean;
destinations: boolean;
link: boolean;
made_for_kids: boolean;
messages: boolean;
persistent_menu: boolean;
products: boolean;
publications: boolean;
reply_control: boolean;
visibility: boolean;
webhooks: boolean;
};
CommentsWebhookChange: {
commentObj?: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
};
field: | "comments"
| "messages"
| "new_account"
| "change_state_account"
| "messaging_postbacks"
| "messaging_seen"
| "messaging_error";
id_account: string;
id_contact?: string;
id_organization: string;
messageObj?: {
_id: string;
contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
creation_date: string;
element_external_id?: string;
from_contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
id_account: string;
in_response_external_id?: string;
in_response_to?: string;
message_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...)
| (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
read: boolean;
text?: string;
};
originalChange?: { [key: string]: unknown };
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
};
Contact: {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
ContactChannel: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
ContactExtraData: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
ContactsContactCreate: {
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
name?: string;
profile_image?: string;
social_identifiers: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
ContactsContactUpdate: {
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
name?: string;
profile_image?: string;
social_identifiers?: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
ContactsSocialIdentifierInput: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
};
DashboardAccountWithError: {
_id: string;
error_code: number;
image?: string;
name: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
DashboardDashboard: {
account_metrics?: {
by_day: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[];
by_network: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[];
previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
ai_plan_results?: {
engagement_per_publication?: number;
engagement_vs_average?: number;
plans: number;
ranked_plans: number;
top: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[];
};
ai_plans?: {
by_state: { state?: string; total?: number }[];
credits_spent: number;
generated_publications: number;
last_plan?: {
_id: string;
creation_date: string;
credits_spent?: number;
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
prompt?: string;
publications?: string[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
pending_validation: number;
total: number;
};
available_blocks: {
account_metrics: boolean;
ai_plan_results: boolean;
ai_plans: boolean;
health: boolean;
messages: boolean;
plan_use: boolean;
publication_metrics: boolean;
publications: boolean;
};
health?: {
accounts_with_errors?: {
_id: string;
error_code: number;
image?: string;
name: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}[];
publications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[];
total_drafts?: number;
upcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[];
};
messages?: { unread: number };
plan_use?: {
actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
};
publication_metrics?: {
by_network: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
top: {
collected_date?: string;
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: (...)
| (...);
cover_image?: (...) | (...);
cover_offset?: (...) | (...);
creation_date: string;
file_externals: (...)[];
file_format: (...) | (...) | (...) | (...) | (...);
file_properties: {
allowed_social_networks: ...;
aspect_ratio: ...;
duration: ...;
height: ...;
size_in_bytes: ...;
width: ...;
};
file_type: (...)
| (...);
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
};
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
publications?: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
by_state: { state?: string; total?: number }[];
published_by_day: {
day?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
total: number;
} & { previous_total?: number };
range: {
from_date: string;
previous_from_date: string;
previous_to_date: string;
to_date: string;
};
};
DashboardDashboardAiPlanRef: {
_id: string;
creation_date: string;
credits_spent?: number;
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
prompt?: string;
publications?: string[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
DashboardDashboardPublicationRef: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
};
DashboardDashboardRange: {
from_date: string;
previous_from_date: string;
previous_to_date: string;
to_date: string;
};
DashboardMetricName: | "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
DashboardMetricRow: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
};
DashboardPlanUse: {
actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
};
DashboardPublicationsSummary: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
by_state: { state?: string; total?: number }[];
published_by_day: {
day?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
total: number;
};
DashboardTopPublication: {
collected_date?: string;
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
};
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
};
Error: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
FileProperties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
IntegrationsGoogleDriveConnectRequest: {
code: string;
provider: "google_drive";
};
IntegrationsIntegration: {
_id: string;
config: {
api_base?: "wp-json"
| "rest_route";
auth_mode?: "query" | "basic";
auto_publish?: boolean;
currency?: string;
id_accounts?: string[];
import_image?: boolean;
key_ending?: string;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
tax_location_missing?: boolean;
template?: string;
url?: string;
};
connected: boolean;
creation_date: string;
enabled: boolean;
error_code?: null
| number;
external_identifier?: string;
id_client: string;
id_organization: string;
last_used_date?: string;
name: string;
provider: "google_drive" | "rss" | "woocommerce";
};
IntegrationsIntegrationCatalogPage: {
items: {
available: boolean;
description?: string;
external_id: string;
image_url?: string;
name: string;
permalink?: string;
price?: string;
}[];
next_cursor?: string;
};
IntegrationsIntegrationCatalogProduct: {
available: boolean;
description?: string;
external_id: string;
image_url?: string;
name: string;
permalink?: string;
price?: string;
};
IntegrationsIntegrationConfig: {
api_base?: "wp-json"
| "rest_route";
auth_mode?: "query" | "basic";
auto_publish?: boolean;
currency?: string;
id_accounts?: string[];
import_image?: boolean;
key_ending?: string;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
tax_location_missing?: boolean;
template?: string;
url?: string;
};
IntegrationsIntegrationFormField: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
};
IntegrationsIntegrationProvider: {
accepted_formats: string[];
catalog: boolean;
config_fields: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}[];
connect_link: boolean;
connect_link_fields: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}[];
content_feed: boolean;
file_import: boolean;
provider: "google_drive"
| "rss"
| "woocommerce";
requires_oauth: boolean;
};
IntegrationsIntegrationProviderName: | "google_drive"
| "rss"
| "woocommerce";
IntegrationsRssConfig: {
auto_publish?: boolean;
id_accounts?: string[];
import_image?: boolean;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
template?: string;
url?: string;
};
IntegrationsRssConnectRequest: {
auto_publish?: boolean;
id_accounts: string[];
import_image?: boolean;
provider: "rss";
publication_type?: string;
template?: string;
url: string;
};
IntegrationsWooCommerceConnectRequest: {
consumer_key: string;
consumer_secret: string;
provider: "woocommerce";
url: string;
};
Message: {
_id: string;
contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
creation_date: string;
element_external_id?: string;
from_contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
id_account: string;
in_response_external_id?: string;
in_response_to?: string;
message_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
read: boolean;
text?: string;
};
MessageOptions: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
MessagesConversation: {
contact: {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
date: string;
unread_messages: number;
};
MessagesConversationTotals: | { total: number }
| {
group: "day" | "month" | "year";
stats: { groupValue: number; totalConversations: number }[];
};
MessagesMessageInput: {
in_response_external_id?: string;
message_options?: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
text?: string;
};
MessageType: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
NormalizedMetrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
Organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
OrganizationsLimit: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
OrganizationsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
name: string;
};
OrganizationsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}[];
total: number;
};
OrganizationsOrganizationOne: {
organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
};
OrganizationsOrganizationUpdate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
stats_settings?: { auto_refresh_twitter: boolean };
};
OrganizationsRolesOrganizationRole: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
};
OrganizationsRolesOrganizationRoleInput: {
name: string;
permissions: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
};
OrganizationsRolesOrganizationRoleList: {
roles?: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
}[];
total?: number;
};
OrganizationsRolesOrganizationRoleOne: {
rol?: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
};
};
OrganizationsRolesPermissionList: {
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
};
OrganizationsRolesUserInOrganization: {
email?: string;
enabled?: boolean;
firstname?: string;
id?: string;
lastname?: string;
roles?: { _id?: string; name?: string }[];
username?: string;
};
OrganizationsRolesUserInOrganizationList: {
total?: number;
users?: {
email?: string;
enabled?: boolean;
firstname?: string;
id?: string;
lastname?: string;
roles?: { _id?: string; name?: string }[];
username?: string;
}[];
};
OrganizationsSocialCredentialsInput: {
bot_token?: string;
client_id?: string;
client_secret?: string;
};
OrganizationsUser: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
};
OrganizationsUserList: {
total?: number;
users?: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
}[];
};
PlanData: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
PlanUseData: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ProductsProduct: {
additional_image_urls?: string[];
availability?: | "pending"
| "in stock"
| "out of stock"
| "preorder"
| "available for order"
| "discontinued"
| "mark_as_sold";
brand?: string;
category?: string;
color?: string;
condition?: | "new"
| "refurbished"
| "used"
| "used_like_new"
| "used_good"
| "used_fair"
| "cpo"
| "open_box_new";
currency: string;
description?: string;
id?: string;
image_url: string;
name: string;
price: number;
retailer_id: string;
url?: string;
} & { [key: string]: unknown };
ProductsProductCatalog: {
default_image_url?: string;
feed_count?: number;
id?: string;
is_catalog_segment?: boolean;
is_local_catalog?: boolean;
name?: string;
product_count?: number;
} & { [key: string]: unknown };
ProductsProductCatalogInput: { name: string };
ProductsProductInput: {
additional_image_urls?: string[];
availability?:
| "pending"
| "in stock"
| "out of stock"
| "preorder"
| "available for order"
| "discontinued"
| "mark_as_sold";
brand?: string;
category?: string;
color?: string;
condition?: | "new"
| "refurbished"
| "used"
| "used_like_new"
| "used_good"
| "used_fair"
| "cpo"
| "open_box_new";
currency: string;
description?: string;
id?: string;
image_url: string;
name: string;
price: number;
retailer_id: string;
url?: string;
} & { [key: string]: unknown };
Publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
PublicationAiGenerated: { image: boolean; text: boolean };
PublicationDestination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
PublicationPending: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
PublicationsDestination: {
description?: string;
id: string;
image?: string;
name: string;
privacy?: string;
sections?: { id: string; name: string }[];
};
PublicationsPublicationInput: {
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
files?: string[];
link?: string;
made_for_kids?: boolean;
name?: string;
publication_type?: "profile"
| "page"
| "group"
| "reels"
| "stories";
publish_date?: string;
reply_control?:
| "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
social_network?: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state?: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
text?: string;
title?: string;
visibility?: "public" | "unlisted" | "private";
};
PublicationsPublicationList: {
publications: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}[];
total: number;
};
PublicationsPublicationOne: {
publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
};
PublicationsPublicationRetry: {
max_retries: number;
publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
};
PublicationsPublicationsStatsList: {
metric?: string;
publications?: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: (...)
| (...)
| (...) } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}[];
range?: {
from_date?: string;
previous_from_date?: string;
previous_to_date?: string;
to_date?: string;
};
summary?: {
by_network?: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: string;
}[];
previous_total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
total?: number;
};
PublicationsPublicationStatsHistory: {
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
latest?: {
collected_date: string;
engagement_base?: "reach" | "impressions" | "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
raw?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
};
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
next_stats_update?: string;
publish_date?: string;
series: {
collected_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
}[];
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
};
PublicationsPublicationStatsPoint: {
collected_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
PublicationStats: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
SocialCredentials: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
SocialIdentifier: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
};
SocialNetwork: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
StatsSettings: { auto_refresh_twitter: boolean };
Success: { success: boolean };
Upload: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
};
UploadsUploadList: {
total: number;
uploads: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
};
UploadsUploadOne: {
upload: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
};
};
};
}
headers: never;
parameters: {
AiPlansfromDate: string;
AiPlansidAiPlan: string;
AiPlansidClient: string;
AiPlansidOrganization: string;
AiPlanstoDate: string;
AppsidApp: string;
AppsidClient: string;
Appslimit: number;
Appsoffset: number;
CommentsidAccount: string;
CommentsidComment: string;
CommentsidOrganization: string;
CommentsidPublication: string;
CommentsthreadLimit: number;
CommentsthreadOffset: string;
ContactsidContact: string;
ContactsidOrganization: string;
Contactslimit: number;
Contactsoffset: number;
DashboardfromDate: string;
DashboardidOrganization: string;
DashboardtoDate: string;
IntegrationsidIntegration: string;
IntegrationsidOrganization: string;
MessagesfromDate: string;
MessagesgroupBy: "day" | "month" | "year";
MessagesidAccount: string;
MessagesidContact: string;
MessagesidOrganization: string;
Messageslimit: number;
Messagesoffset: number;
MessagestoDate: string;
OrganizationsRolesidOrganization: string;
OrganizationsRolesidRol: string;
OrganizationsRolesidUser: string;
OrganizationsRoleslimit: number;
OrganizationsRolesoffset: number;
ProductsidAccount: string;
ProductsidOrganization: string;
Productslimit: number;
Productsoffset: number;
};
pathItems: never;
requestBodies: never;
responses: {
AppsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
CommentsCommentError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
ContactsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
DashboardError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
MessagesError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
ProductsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
};
schemas: {
Account: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
AccountsAccountList: {
accounts: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}[];
total: number;
};
AccountsAccountOne: {
account: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
};
AccountsConnectSession: {
_id: string;
accounts: (
{
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
} & { already_enabled: boolean }
)[];
accounts_limit: number;
accounts_used: number;
creation_date?: string;
expires_at: string;
id_client?: string;
id_organization?: string;
keycloak_client_idenfifier?: string;
redirect_uri?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
status: "pending"
| "returned"
| "confirmed";
};
AccountsConnectSessionAccount: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
} & { already_enabled: boolean };
AccountsMetricList: (
| "reach"
| "impressions"
| "comments"
| "likes"
| "shares"
| "saves"
| "profile_views"
| "page_impressions"
| "page_total_actions"
| "page_call_phone_clicks_logged_in_unique"
| "page_get_directions_clicks_logged_in_unique"
| "page_website_clicks_logged_in_unique"
| "page_post_engagements"
| "page_consumptions_unique"
| "page_negative_feedback"
| "page_negative_feedback_unique"
| "page_fans_online_per_day"
| "page_impressions_unique"
| "page_impressions_paid"
| "page_impressions_paid_unique"
| "page_impressions_organic_v2"
| "page_impressions_organic_unique_v2"
| "page_impressions_viral"
| "page_impressions_viral_unique"
| "page_impressions_nonviral"
| "page_impressions_nonviral_unique"
| "page_posts_impressions"
| "page_posts_impressions_unique"
| "page_posts_impressions_paid"
| "page_posts_impressions_paid_unique"
| "page_posts_impressions_organic"
| "page_posts_impressions_organic_unique"
| "page_posts_served_impressions_organic_unique"
| "page_posts_impressions_viral"
| "page_posts_impressions_viral_unique"
| "page_posts_impressions_nonviral"
| "page_posts_impressions_nonviral_unique"
| "total_interactions"
| "accounts_engaged"
| "replies"
| "follows_and_unfollows"
| "profile_links_taps"
| "website_clicks"
| "paidFollowers"
| "organicFollowerGain"
| "careersPageBannerPromoClicks"
| "careersPagePromoLinksClicks"
| "careersPageEmployeesClicks"
| "careersPageJobsClicks"
| "careersPageViewsUnique"
| "careersPageViews"
| "overviewPageViewsUnique"
| "overviewPageViews"
| "allPageViews"
| "follows"
| "share"
| "views"
)[];
AccountsMetricModel: {
group: "day"
| "month"
| "year";
stats: {
date: string;
group: "day" | "month" | "year";
group_value: number;
name: string;
value: number;
}[];
};
AccountsPersistentMenu: {
call_to_actions?: { [key: string]: unknown }[];
composer_input_disabled?: boolean;
locale?: string;
}[];
AccountsSocialAuthorizationMethod: {
add_to_group_link?: string;
app_id?: string;
bot_username?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
state?: string;
type: "telegram_bot"
| "redirect"
| "meta_embedded_signup";
};
AccountsSocialLinksList: {
links: {
authorization: {
add_to_group_link?: string;
app_id?: string;
bot_username?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
state?: string;
type: "telegram_bot"
| "redirect"
| "meta_embedded_signup";
};
link: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
};
AiContext: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
AiImageOrigin: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
AiPlanResult: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
};
AiPlanResultsGroup: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
};
AiPlansAiPlan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: (...)
| (...)
| (...) } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
AiPlansAiPlanCostEstimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
AiPlansAiPlanCreateRequest: {
accounts: string[];
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
options?: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
link?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
prompt: string;
source?: {
event_date?: string;
event_name?: string;
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description: string; id_upload: string }[];
product_catalog_id?: string;
products?: string[];
text?: string;
url?: string;
};
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
};
AiPlansAiPlanCreateResponse: {
ai_plan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
estimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
estimated_cost: number;
};
AiPlansAiPlanDestination: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
};
AiPlansAiPlanList: {
ai_plans: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: ...;
id_ai_plan?: ...;
model: ...;
provider: ...;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: ...;
external_url: ...;
social_network: ...;
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: (...)[];
aspect_ratio: { text: ...; value: ... };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: (...) & (...);
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: ...]: ... };
deadline?: string;
next_check?: string;
temp_keys?: (...)[];
};
publication_errors: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: ...]: ... };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
}[];
total: number;
};
AiPlansAiPlanNotice: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
AiPlansAiPlanOne: {
ai_plan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
};
AiPlansAiPlanOptions: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
AiPlansAiPlanOptionsInput: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
link?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
AiPlansAiPlanResults: {
ai_plans: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[];
by_template: (
{
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
} & {
template: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
}
)[];
range: {
from_date: string;
previous_from_date?: string;
previous_to_date?: string;
to_date: string;
};
sort: string;
total: number;
totals: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
};
};
AiPlansAiPlanResultsTemplateGroup: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
} & {
template: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
};
AiPlansAiPlanSource: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
AiPlansAiPlanSourceImageInput: { description: string; id_upload: string };
AiPlansAiPlanSourceInput: {
event_date?: string;
event_name?: string;
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description: string; id_upload: string }[];
product_catalog_id?: string;
products?: string[];
text?: string;
url?: string;
};
AiPlansAiPlanSourceProduct: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
};
AppsClientApp: {
_id: string;
allowed_domains: string[];
creation_date: string;
deleted: boolean;
deleted_date?: string;
id_client: string;
id_user?: string;
keycloak_client_idenfifier: string;
name: string;
redirect_urls: string[];
webhook_url?: string;
};
AppsClientAppInput: {
allowed_domains?: string[];
keycloak_client_idenfifier: string;
name: string;
redirect_urls?: string[];
webhook_url?: string;
};
AppsOAuthError: {
error: | "server_error"
| "invalid_client"
| "slow_down"
| "invalid_request"
| "unsupported_grant_type";
error_description?: string;
};
AppsTokenRequest: {
client_id?: string;
client_secret?: string;
grant_type: "client_credentials";
scope?: string;
};
AppsTokenResponse: {
access_token: string;
expires_in: number;
scope?: string;
token_type: string;
};
CatalogAspectRatios: { text: string[]; values: number[] };
CatalogPlannerTemplate: {
allows_gallery?: boolean;
allows_shared?: boolean;
generates_images?: boolean;
max_source_items?: number;
orchestration_cost?: number;
orchestration_cost_per_source_item?: number;
regenerate?: { image?: boolean; text?: boolean };
source_fields?: {
default?: unknown;
max?: number;
min?: number;
name?: string;
options?: string[];
required?: boolean;
type?:
| "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "date"
| "uploads_with_description"
| "catalog_products";
}[];
source_requires_any?: string[];
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
unsupported_networks?: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
};
CatalogPlannerTemplateField: {
default?: unknown;
max?: number;
min?: number;
name?: string;
options?: string[];
required?: boolean;
type?: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "date"
| "uploads_with_description"
| "catalog_products";
};
CatalogSocialLimits: {
characters: { [key: string]: number };
comment_characters: { [key: string]: number };
max_file_size_mb: { [key: string]: number };
max_post_bytes: { [key: string]: number };
title_characters: { [key: string]: number };
total_images: { [key: string]: number };
video_duration_in_seconds: { [key: string]: number };
};
CatalogSocialLimitsMap: { [key: string]: number };
ClientsAiScopeSetting: {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter" | "openai" | "google" | "anthropic";
};
ClientsAiSettings: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
ClientsClient: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
};
ClientsClientList: {
clients: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
}[];
total: number;
};
ClientsClientOne: {
client: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
};
};
ClientsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
name: string;
};
ClientsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}[];
total: number;
};
ClientsOrganizationOne: {
organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
};
ClientsOrganizationUpdate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
stats_settings?: { auto_refresh_twitter: boolean };
};
ClientsPlan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
ClientsRolesClientPermissions: | "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read";
ClientsRolesClientPermissionsList: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
ClientsRolesClientPermissionsOne: {
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
ClientsRolesRole: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
ClientsRolesRoleInput: {
name: string;
permissions: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
| "client_organization_products:create"
| "client_organization_products:update"
| "client_organization_products:read"
| "client_organization_products:delete"
| "client_organization_messages:create"
| "client_organization_messages:read"
| "client_organization_messages:delete"
| "client_organization_contacts:create"
| "client_organization_contacts:read"
| "client_organization_contacts:update"
| "client_organization_contacts:delete"
| "client_organization_ai_plans:create"
| "client_organization_ai_plans:read"
| "client_organization_ai_plans:update"
| "client_organization_ai_plans:delete"
)[];
};
ClientsRolesRoleList: {
roles?: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
}[];
total?: number;
};
ClientsRolesRoleOne: {
rol?: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
};
ClientsRolesUser: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
};
ClientsRolesUserList: {
total?: number;
users?: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
}[];
};
CommentsAiPlanWebhookChange: {
credits_spent: number;
error?: { code: number; message: string };
field: "ai_plan_generated" | "ai_plan_failed";
id_ai_plan: string;
id_organization: string;
state: "generated" | "failed";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
total_publications: number;
warnings: number;
};
CommentsAiPlanWebhookError: { code: number; message: string };
CommentsComment: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
};
CommentsCommentActions: {
delete_others: boolean;
delete_own: boolean;
hide: boolean;
reply: boolean;
};
CommentsCommentAuthor: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
CommentsCommentNetworkName: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
CommentsCommentThread: {
comments: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
}[];
credits_consumed: number;
next_cursor?: string;
total: number;
};
CommentsIntegrationWebhookChange: {
error_code: number;
field: "integration_error";
id_integration: string;
id_organization: string;
provider: string;
};
CommentsSocialCapabilities: {
comments: boolean;
destinations: boolean;
link: boolean;
made_for_kids: boolean;
messages: boolean;
persistent_menu: boolean;
products: boolean;
publications: boolean;
reply_control: boolean;
visibility: boolean;
webhooks: boolean;
};
CommentsWebhookChange: {
commentObj?: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
};
field: | "comments"
| "messages"
| "new_account"
| "change_state_account"
| "messaging_postbacks"
| "messaging_seen"
| "messaging_error";
id_account: string;
id_contact?: string;
id_organization: string;
messageObj?: {
_id: string;
contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
creation_date: string;
element_external_id?: string;
from_contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
id_account: string;
in_response_external_id?: string;
in_response_to?: string;
message_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...)
| (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
read: boolean;
text?: string;
};
originalChange?: { [key: string]: unknown };
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
};
Contact: {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
ContactChannel: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
ContactExtraData: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
ContactsContactCreate: {
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
name?: string;
profile_image?: string;
social_identifiers: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
ContactsContactUpdate: {
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
name?: string;
profile_image?: string;
social_identifiers?: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
ContactsSocialIdentifierInput: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
};
DashboardAccountWithError: {
_id: string;
error_code: number;
image?: string;
name: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
DashboardDashboard: {
account_metrics?: {
by_day: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[];
by_network: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[];
previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
ai_plan_results?: {
engagement_per_publication?: number;
engagement_vs_average?: number;
plans: number;
ranked_plans: number;
top: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[];
};
ai_plans?: {
by_state: { state?: string; total?: number }[];
credits_spent: number;
generated_publications: number;
last_plan?: {
_id: string;
creation_date: string;
credits_spent?: number;
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
prompt?: string;
publications?: string[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
pending_validation: number;
total: number;
};
available_blocks: {
account_metrics: boolean;
ai_plan_results: boolean;
ai_plans: boolean;
health: boolean;
messages: boolean;
plan_use: boolean;
publication_metrics: boolean;
publications: boolean;
};
health?: {
accounts_with_errors?: {
_id: string;
error_code: number;
image?: string;
name: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}[];
publications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[];
total_drafts?: number;
upcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[];
};
messages?: { unread: number };
plan_use?: {
actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
};
publication_metrics?: {
by_network: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
top: {
collected_date?: string;
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: (...)
| (...);
cover_image?: (...) | (...);
cover_offset?: (...) | (...);
creation_date: string;
file_externals: (...)[];
file_format: (...) | (...) | (...) | (...) | (...);
file_properties: {
allowed_social_networks: ...;
aspect_ratio: ...;
duration: ...;
height: ...;
size_in_bytes: ...;
width: ...;
};
file_type: (...)
| (...);
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
};
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
publications?: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
by_state: { state?: string; total?: number }[];
published_by_day: {
day?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
total: number;
} & { previous_total?: number };
range: {
from_date: string;
previous_from_date: string;
previous_to_date: string;
to_date: string;
};
};
DashboardDashboardAiPlanRef: {
_id: string;
creation_date: string;
credits_spent?: number;
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
prompt?: string;
publications?: string[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
DashboardDashboardPublicationRef: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
};
DashboardDashboardRange: {
from_date: string;
previous_from_date: string;
previous_to_date: string;
to_date: string;
};
DashboardMetricName: | "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
DashboardMetricRow: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
};
DashboardPlanUse: {
actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
};
DashboardPublicationsSummary: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
by_state: { state?: string; total?: number }[];
published_by_day: {
day?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
total: number;
};
DashboardTopPublication: {
collected_date?: string;
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
};
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
};
Error: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
FileProperties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
IntegrationsGoogleDriveConnectRequest: {
code: string;
provider: "google_drive";
};
IntegrationsIntegration: {
_id: string;
config: {
api_base?: "wp-json"
| "rest_route";
auth_mode?: "query" | "basic";
auto_publish?: boolean;
currency?: string;
id_accounts?: string[];
import_image?: boolean;
key_ending?: string;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
tax_location_missing?: boolean;
template?: string;
url?: string;
};
connected: boolean;
creation_date: string;
enabled: boolean;
error_code?: null
| number;
external_identifier?: string;
id_client: string;
id_organization: string;
last_used_date?: string;
name: string;
provider: "google_drive" | "rss" | "woocommerce";
};
IntegrationsIntegrationCatalogPage: {
items: {
available: boolean;
description?: string;
external_id: string;
image_url?: string;
name: string;
permalink?: string;
price?: string;
}[];
next_cursor?: string;
};
IntegrationsIntegrationCatalogProduct: {
available: boolean;
description?: string;
external_id: string;
image_url?: string;
name: string;
permalink?: string;
price?: string;
};
IntegrationsIntegrationConfig: {
api_base?: "wp-json"
| "rest_route";
auth_mode?: "query" | "basic";
auto_publish?: boolean;
currency?: string;
id_accounts?: string[];
import_image?: boolean;
key_ending?: string;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
tax_location_missing?: boolean;
template?: string;
url?: string;
};
IntegrationsIntegrationFormField: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
};
IntegrationsIntegrationProvider: {
accepted_formats: string[];
catalog: boolean;
config_fields: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}[];
connect_link: boolean;
connect_link_fields: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}[];
content_feed: boolean;
file_import: boolean;
provider: "google_drive"
| "rss"
| "woocommerce";
requires_oauth: boolean;
};
IntegrationsIntegrationProviderName: | "google_drive"
| "rss"
| "woocommerce";
IntegrationsRssConfig: {
auto_publish?: boolean;
id_accounts?: string[];
import_image?: boolean;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
template?: string;
url?: string;
};
IntegrationsRssConnectRequest: {
auto_publish?: boolean;
id_accounts: string[];
import_image?: boolean;
provider: "rss";
publication_type?: string;
template?: string;
url: string;
};
IntegrationsWooCommerceConnectRequest: {
consumer_key: string;
consumer_secret: string;
provider: "woocommerce";
url: string;
};
Message: {
_id: string;
contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
creation_date: string;
element_external_id?: string;
from_contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
id_account: string;
in_response_external_id?: string;
in_response_to?: string;
message_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
read: boolean;
text?: string;
};
MessageOptions: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
MessagesConversation: {
contact: {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
date: string;
unread_messages: number;
};
MessagesConversationTotals: | { total: number }
| {
group: "day" | "month" | "year";
stats: { groupValue: number; totalConversations: number }[];
};
MessagesMessageInput: {
in_response_external_id?: string;
message_options?: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
text?: string;
};
MessageType: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
NormalizedMetrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
Organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
OrganizationsLimit: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
OrganizationsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
name: string;
};
OrganizationsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}[];
total: number;
};
OrganizationsOrganizationOne: {
organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
};
OrganizationsOrganizationUpdate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
stats_settings?: { auto_refresh_twitter: boolean };
};
OrganizationsRolesOrganizationRole: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
};
OrganizationsRolesOrganizationRoleInput: {
name: string;
permissions: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
};
OrganizationsRolesOrganizationRoleList: {
roles?: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
}[];
total?: number;
};
OrganizationsRolesOrganizationRoleOne: {
rol?: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
};
};
OrganizationsRolesPermissionList: {
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
};
OrganizationsRolesUserInOrganization: {
email?: string;
enabled?: boolean;
firstname?: string;
id?: string;
lastname?: string;
roles?: { _id?: string; name?: string }[];
username?: string;
};
OrganizationsRolesUserInOrganizationList: {
total?: number;
users?: {
email?: string;
enabled?: boolean;
firstname?: string;
id?: string;
lastname?: string;
roles?: { _id?: string; name?: string }[];
username?: string;
}[];
};
OrganizationsSocialCredentialsInput: {
bot_token?: string;
client_id?: string;
client_secret?: string;
};
OrganizationsUser: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
};
OrganizationsUserList: {
total?: number;
users?: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
}[];
};
PlanData: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
PlanUseData: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ProductsProduct: {
additional_image_urls?: string[];
availability?: | "pending"
| "in stock"
| "out of stock"
| "preorder"
| "available for order"
| "discontinued"
| "mark_as_sold";
brand?: string;
category?: string;
color?: string;
condition?: | "new"
| "refurbished"
| "used"
| "used_like_new"
| "used_good"
| "used_fair"
| "cpo"
| "open_box_new";
currency: string;
description?: string;
id?: string;
image_url: string;
name: string;
price: number;
retailer_id: string;
url?: string;
} & { [key: string]: unknown };
ProductsProductCatalog: {
default_image_url?: string;
feed_count?: number;
id?: string;
is_catalog_segment?: boolean;
is_local_catalog?: boolean;
name?: string;
product_count?: number;
} & { [key: string]: unknown };
ProductsProductCatalogInput: { name: string };
ProductsProductInput: {
additional_image_urls?: string[];
availability?:
| "pending"
| "in stock"
| "out of stock"
| "preorder"
| "available for order"
| "discontinued"
| "mark_as_sold";
brand?: string;
category?: string;
color?: string;
condition?: | "new"
| "refurbished"
| "used"
| "used_like_new"
| "used_good"
| "used_fair"
| "cpo"
| "open_box_new";
currency: string;
description?: string;
id?: string;
image_url: string;
name: string;
price: number;
retailer_id: string;
url?: string;
} & { [key: string]: unknown };
Publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
PublicationAiGenerated: { image: boolean; text: boolean };
PublicationDestination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
PublicationPending: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
PublicationsDestination: {
description?: string;
id: string;
image?: string;
name: string;
privacy?: string;
sections?: { id: string; name: string }[];
};
PublicationsPublicationInput: {
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
files?: string[];
link?: string;
made_for_kids?: boolean;
name?: string;
publication_type?: "profile"
| "page"
| "group"
| "reels"
| "stories";
publish_date?: string;
reply_control?:
| "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
social_network?: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state?: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
text?: string;
title?: string;
visibility?: "public" | "unlisted" | "private";
};
PublicationsPublicationList: {
publications: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}[];
total: number;
};
PublicationsPublicationOne: {
publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
};
PublicationsPublicationRetry: {
max_retries: number;
publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
};
PublicationsPublicationsStatsList: {
metric?: string;
publications?: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: (...)
| (...)
| (...) } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}[];
range?: {
from_date?: string;
previous_from_date?: string;
previous_to_date?: string;
to_date?: string;
};
summary?: {
by_network?: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: string;
}[];
previous_total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
total?: number;
};
PublicationsPublicationStatsHistory: {
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
latest?: {
collected_date: string;
engagement_base?: "reach" | "impressions" | "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
raw?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
};
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
next_stats_update?: string;
publish_date?: string;
series: {
collected_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
}[];
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
};
PublicationsPublicationStatsPoint: {
collected_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
PublicationStats: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
SocialCredentials: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
SocialIdentifier: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
};
SocialNetwork: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
StatsSettings: { auto_refresh_twitter: boolean };
Success: { success: boolean };
Upload: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
};
UploadsUploadList: {
total: number;
uploads: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
};
UploadsUploadOne: {
upload: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
};
};
};
}
Index
Properties
Properties
headers
headers: never
parameters
parameters: {
AiPlansfromDate: string;
AiPlansidAiPlan: string;
AiPlansidClient: string;
AiPlansidOrganization: string;
AiPlanstoDate: string;
AppsidApp: string;
AppsidClient: string;
Appslimit: number;
Appsoffset: number;
CommentsidAccount: string;
CommentsidComment: string;
CommentsidOrganization: string;
CommentsidPublication: string;
CommentsthreadLimit: number;
CommentsthreadOffset: string;
ContactsidContact: string;
ContactsidOrganization: string;
Contactslimit: number;
Contactsoffset: number;
DashboardfromDate: string;
DashboardidOrganization: string;
DashboardtoDate: string;
IntegrationsidIntegration: string;
IntegrationsidOrganization: string;
MessagesfromDate: string;
MessagesgroupBy: "day" | "month" | "year";
MessagesidAccount: string;
MessagesidContact: string;
MessagesidOrganization: string;
Messageslimit: number;
Messagesoffset: number;
MessagestoDate: string;
OrganizationsRolesidOrganization: string;
OrganizationsRolesidRol: string;
OrganizationsRolesidUser: string;
OrganizationsRoleslimit: number;
OrganizationsRolesoffset: number;
ProductsidAccount: string;
ProductsidOrganization: string;
Productslimit: number;
Productsoffset: number;
}
AiPlansfromDate: string;
AiPlansidAiPlan: string;
AiPlansidClient: string;
AiPlansidOrganization: string;
AiPlanstoDate: string;
AppsidApp: string;
AppsidClient: string;
Appslimit: number;
Appsoffset: number;
CommentsidAccount: string;
CommentsidComment: string;
CommentsidOrganization: string;
CommentsidPublication: string;
CommentsthreadLimit: number;
CommentsthreadOffset: string;
ContactsidContact: string;
ContactsidOrganization: string;
Contactslimit: number;
Contactsoffset: number;
DashboardfromDate: string;
DashboardidOrganization: string;
DashboardtoDate: string;
IntegrationsidIntegration: string;
IntegrationsidOrganization: string;
MessagesfromDate: string;
MessagesgroupBy: "day" | "month" | "year";
MessagesidAccount: string;
MessagesidContact: string;
MessagesidOrganization: string;
Messageslimit: number;
Messagesoffset: number;
MessagestoDate: string;
OrganizationsRolesidOrganization: string;
OrganizationsRolesidRol: string;
OrganizationsRolesidUser: string;
OrganizationsRoleslimit: number;
OrganizationsRolesoffset: number;
ProductsidAccount: string;
ProductsidOrganization: string;
Productslimit: number;
Productsoffset: number;
}
Type declaration
AiPlansfromDate: string
AiPlansidAiPlan: string
AiPlansidClient: string
AiPlansidOrganization: string
AiPlanstoDate: string
AppsidApp: string
AppsidClient: string
Appslimit: number
Appsoffset: number
CommentsidAccount: string
CommentsidComment: string
CommentsidOrganization: string
CommentsidPublication: string
CommentsthreadLimit: number
CommentsthreadOffset: string
ContactsidContact: string
ContactsidOrganization: string
Contactslimit: number
Contactsoffset: number
DashboardfromDate: string
DashboardidOrganization: string
DashboardtoDate: string
IntegrationsidIntegration: string
IntegrationsidOrganization: string
MessagesfromDate: string
MessagesgroupBy: "day" | "month" | "year"
MessagesidAccount: string
MessagesidContact: string
MessagesidOrganization: string
Messageslimit: number
Messagesoffset: number
MessagestoDate: string
OrganizationsRolesidOrganization: string
OrganizationsRolesidRol: string
OrganizationsRolesidUser: string
OrganizationsRoleslimit: number
OrganizationsRolesoffset: number
ProductsidAccount: string
ProductsidOrganization: string
Productslimit: number
Productsoffset: number
path
pathItems: never
request
requestBodies: never
responses
responses: {
AppsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
CommentsCommentError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
ContactsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
DashboardError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
MessagesError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
ProductsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
}
AppsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
CommentsCommentError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
ContactsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
DashboardError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
MessagesError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
ProductsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
};
}
Type declaration
AppsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
}CommentsCommentError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
}Description
The request failed. The body carries the PlanVortex error code in
code:| Code | Meaning | | --- | --- | | `516` | Comments require a paid plan. Every endpoint here returns this on the free plan. | | `700` | The account is not connected — no valid token, or nothing to ask the network about. | | `936` | The publication was never sent, so it has no thread to read. | | `940` | The client's monthly X credits are exhausted. Only X. | | `945` | This network has no comments (TikTok, WhatsApp). Carries `social_network` in `data`. | | `946` | The network has comments but does not allow **this action**: hiding on LinkedIn or Google Business, deleting someone else's on Instagram or X, deleting a review. Carries `social_network` and `action` in `data`. See `GET /social_comment_actions`. | | `947` | The comment no longer exists on the network. What is stored is a photograph; the network always wins. Carries `external_id` in `data`. | | `948` | The reply is empty or longer than the network allows. Carries the limit in `data.max`; the same number is published in `comment_characters` of `GET /social_limits`. | | `951` | The Google Business listing is not verified, so it cannot reply to its reviews. It is the state of the customer's profile, not of your token. | | `952` | PlanVortex's Google Cloud project has no approved access to the Google Business API yet. Until it does, reviews cannot be read or replied to. | | `965` | This Telegram channel has no linked discussion group, so it has no comments. The network gate says `true`; what is missing is a setting of **that channel**, which its owner fixes in two taps. Carries `chat_id` in `data`. | | `969` | The PlanVortex bot is not allowed to delete messages in this Telegram discussion group. The network allows it; this installation does not. Carries `chat_id` in `data`. | | `970` | Telegram is rate limiting the bot and the wait was longer than PlanVortex is willing to hold the request for. Carries `retry_after_seconds` in `data`: retry after it. | | `1101` | Invalid organization. | | `1501` | The comment's account could not be resolved. | | `2600` | The network has comments but **this account** has none: a LinkedIn personal profile. LinkedIn does not let any app read a member's comments, so only pages have an inbox. Carries `social_network` and `id_account` in `data`. |ContactsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
}DashboardError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
}MessagesError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
}ProductsError: {
content: {
"application/json": {
code: number;
data?: { [key: string]: unknown };
message: string;
};
};
headers: { [name: string]: unknown };
}
schemas
schemas: {
Account: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
AccountsAccountList: {
accounts: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}[];
total: number;
};
AccountsAccountOne: {
account: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
};
AccountsConnectSession: {
_id: string;
accounts: (
{
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
} & { already_enabled: boolean }
)[];
accounts_limit: number;
accounts_used: number;
creation_date?: string;
expires_at: string;
id_client?: string;
id_organization?: string;
keycloak_client_idenfifier?: string;
redirect_uri?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
status: "pending"
| "returned"
| "confirmed";
};
AccountsConnectSessionAccount: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
} & { already_enabled: boolean };
AccountsMetricList: (
| "reach"
| "impressions"
| "comments"
| "likes"
| "shares"
| "saves"
| "profile_views"
| "page_impressions"
| "page_total_actions"
| "page_call_phone_clicks_logged_in_unique"
| "page_get_directions_clicks_logged_in_unique"
| "page_website_clicks_logged_in_unique"
| "page_post_engagements"
| "page_consumptions_unique"
| "page_negative_feedback"
| "page_negative_feedback_unique"
| "page_fans_online_per_day"
| "page_impressions_unique"
| "page_impressions_paid"
| "page_impressions_paid_unique"
| "page_impressions_organic_v2"
| "page_impressions_organic_unique_v2"
| "page_impressions_viral"
| "page_impressions_viral_unique"
| "page_impressions_nonviral"
| "page_impressions_nonviral_unique"
| "page_posts_impressions"
| "page_posts_impressions_unique"
| "page_posts_impressions_paid"
| "page_posts_impressions_paid_unique"
| "page_posts_impressions_organic"
| "page_posts_impressions_organic_unique"
| "page_posts_served_impressions_organic_unique"
| "page_posts_impressions_viral"
| "page_posts_impressions_viral_unique"
| "page_posts_impressions_nonviral"
| "page_posts_impressions_nonviral_unique"
| "total_interactions"
| "accounts_engaged"
| "replies"
| "follows_and_unfollows"
| "profile_links_taps"
| "website_clicks"
| "paidFollowers"
| "organicFollowerGain"
| "careersPageBannerPromoClicks"
| "careersPagePromoLinksClicks"
| "careersPageEmployeesClicks"
| "careersPageJobsClicks"
| "careersPageViewsUnique"
| "careersPageViews"
| "overviewPageViewsUnique"
| "overviewPageViews"
| "allPageViews"
| "follows"
| "share"
| "views"
)[];
AccountsMetricModel: {
group: "day"
| "month"
| "year";
stats: {
date: string;
group: "day" | "month" | "year";
group_value: number;
name: string;
value: number;
}[];
};
AccountsPersistentMenu: {
call_to_actions?: { [key: string]: unknown }[];
composer_input_disabled?: boolean;
locale?: string;
}[];
AccountsSocialAuthorizationMethod: {
add_to_group_link?: string;
app_id?: string;
bot_username?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
state?: string;
type: "telegram_bot"
| "redirect"
| "meta_embedded_signup";
};
AccountsSocialLinksList: {
links: {
authorization: {
add_to_group_link?: string;
app_id?: string;
bot_username?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
state?: string;
type: "telegram_bot"
| "redirect"
| "meta_embedded_signup";
};
link: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
};
AiContext: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
AiImageOrigin: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
AiPlanResult: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
};
AiPlanResultsGroup: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
};
AiPlansAiPlan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: (...)
| (...)
| (...) } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
AiPlansAiPlanCostEstimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
AiPlansAiPlanCreateRequest: {
accounts: string[];
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
options?: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
link?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
prompt: string;
source?: {
event_date?: string;
event_name?: string;
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description: string; id_upload: string }[];
product_catalog_id?: string;
products?: string[];
text?: string;
url?: string;
};
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
};
AiPlansAiPlanCreateResponse: {
ai_plan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
estimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
estimated_cost: number;
};
AiPlansAiPlanDestination: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
};
AiPlansAiPlanList: {
ai_plans: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: ...;
id_ai_plan?: ...;
model: ...;
provider: ...;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: ...;
external_url: ...;
social_network: ...;
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: (...)[];
aspect_ratio: { text: ...; value: ... };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: (...) & (...);
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: ...]: ... };
deadline?: string;
next_check?: string;
temp_keys?: (...)[];
};
publication_errors: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: ...]: ... };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
}[];
total: number;
};
AiPlansAiPlanNotice: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
AiPlansAiPlanOne: {
ai_plan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
};
AiPlansAiPlanOptions: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
AiPlansAiPlanOptionsInput: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
link?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
AiPlansAiPlanResults: {
ai_plans: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[];
by_template: (
{
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
} & {
template: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
}
)[];
range: {
from_date: string;
previous_from_date?: string;
previous_to_date?: string;
to_date: string;
};
sort: string;
total: number;
totals: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
};
};
AiPlansAiPlanResultsTemplateGroup: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
} & {
template: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
};
AiPlansAiPlanSource: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
AiPlansAiPlanSourceImageInput: { description: string; id_upload: string };
AiPlansAiPlanSourceInput: {
event_date?: string;
event_name?: string;
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description: string; id_upload: string }[];
product_catalog_id?: string;
products?: string[];
text?: string;
url?: string;
};
AiPlansAiPlanSourceProduct: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
};
AppsClientApp: {
_id: string;
allowed_domains: string[];
creation_date: string;
deleted: boolean;
deleted_date?: string;
id_client: string;
id_user?: string;
keycloak_client_idenfifier: string;
name: string;
redirect_urls: string[];
webhook_url?: string;
};
AppsClientAppInput: {
allowed_domains?: string[];
keycloak_client_idenfifier: string;
name: string;
redirect_urls?: string[];
webhook_url?: string;
};
AppsOAuthError: {
error: | "server_error"
| "invalid_client"
| "slow_down"
| "invalid_request"
| "unsupported_grant_type";
error_description?: string;
};
AppsTokenRequest: {
client_id?: string;
client_secret?: string;
grant_type: "client_credentials";
scope?: string;
};
AppsTokenResponse: {
access_token: string;
expires_in: number;
scope?: string;
token_type: string;
};
CatalogAspectRatios: { text: string[]; values: number[] };
CatalogPlannerTemplate: {
allows_gallery?: boolean;
allows_shared?: boolean;
generates_images?: boolean;
max_source_items?: number;
orchestration_cost?: number;
orchestration_cost_per_source_item?: number;
regenerate?: { image?: boolean; text?: boolean };
source_fields?: {
default?: unknown;
max?: number;
min?: number;
name?: string;
options?: string[];
required?: boolean;
type?:
| "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "date"
| "uploads_with_description"
| "catalog_products";
}[];
source_requires_any?: string[];
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
unsupported_networks?: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
};
CatalogPlannerTemplateField: {
default?: unknown;
max?: number;
min?: number;
name?: string;
options?: string[];
required?: boolean;
type?: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "date"
| "uploads_with_description"
| "catalog_products";
};
CatalogSocialLimits: {
characters: { [key: string]: number };
comment_characters: { [key: string]: number };
max_file_size_mb: { [key: string]: number };
max_post_bytes: { [key: string]: number };
title_characters: { [key: string]: number };
total_images: { [key: string]: number };
video_duration_in_seconds: { [key: string]: number };
};
CatalogSocialLimitsMap: { [key: string]: number };
ClientsAiScopeSetting: {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter" | "openai" | "google" | "anthropic";
};
ClientsAiSettings: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
ClientsClient: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
};
ClientsClientList: {
clients: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
}[];
total: number;
};
ClientsClientOne: {
client: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
};
};
ClientsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
name: string;
};
ClientsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}[];
total: number;
};
ClientsOrganizationOne: {
organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
};
ClientsOrganizationUpdate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
stats_settings?: { auto_refresh_twitter: boolean };
};
ClientsPlan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
ClientsRolesClientPermissions: | "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read";
ClientsRolesClientPermissionsList: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
ClientsRolesClientPermissionsOne: {
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
ClientsRolesRole: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
ClientsRolesRoleInput: {
name: string;
permissions: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
| "client_organization_products:create"
| "client_organization_products:update"
| "client_organization_products:read"
| "client_organization_products:delete"
| "client_organization_messages:create"
| "client_organization_messages:read"
| "client_organization_messages:delete"
| "client_organization_contacts:create"
| "client_organization_contacts:read"
| "client_organization_contacts:update"
| "client_organization_contacts:delete"
| "client_organization_ai_plans:create"
| "client_organization_ai_plans:read"
| "client_organization_ai_plans:update"
| "client_organization_ai_plans:delete"
)[];
};
ClientsRolesRoleList: {
roles?: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
}[];
total?: number;
};
ClientsRolesRoleOne: {
rol?: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
};
ClientsRolesUser: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
};
ClientsRolesUserList: {
total?: number;
users?: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
}[];
};
CommentsAiPlanWebhookChange: {
credits_spent: number;
error?: { code: number; message: string };
field: "ai_plan_generated" | "ai_plan_failed";
id_ai_plan: string;
id_organization: string;
state: "generated" | "failed";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
total_publications: number;
warnings: number;
};
CommentsAiPlanWebhookError: { code: number; message: string };
CommentsComment: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
};
CommentsCommentActions: {
delete_others: boolean;
delete_own: boolean;
hide: boolean;
reply: boolean;
};
CommentsCommentAuthor: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
CommentsCommentNetworkName: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
CommentsCommentThread: {
comments: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
}[];
credits_consumed: number;
next_cursor?: string;
total: number;
};
CommentsIntegrationWebhookChange: {
error_code: number;
field: "integration_error";
id_integration: string;
id_organization: string;
provider: string;
};
CommentsSocialCapabilities: {
comments: boolean;
destinations: boolean;
link: boolean;
made_for_kids: boolean;
messages: boolean;
persistent_menu: boolean;
products: boolean;
publications: boolean;
reply_control: boolean;
visibility: boolean;
webhooks: boolean;
};
CommentsWebhookChange: {
commentObj?: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
};
field: | "comments"
| "messages"
| "new_account"
| "change_state_account"
| "messaging_postbacks"
| "messaging_seen"
| "messaging_error";
id_account: string;
id_contact?: string;
id_organization: string;
messageObj?: {
_id: string;
contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
creation_date: string;
element_external_id?: string;
from_contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
id_account: string;
in_response_external_id?: string;
in_response_to?: string;
message_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...)
| (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
read: boolean;
text?: string;
};
originalChange?: { [key: string]: unknown };
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
};
Contact: {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
ContactChannel: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
ContactExtraData: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
ContactsContactCreate: {
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
name?: string;
profile_image?: string;
social_identifiers: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
ContactsContactUpdate: {
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
name?: string;
profile_image?: string;
social_identifiers?: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
ContactsSocialIdentifierInput: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
};
DashboardAccountWithError: {
_id: string;
error_code: number;
image?: string;
name: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
DashboardDashboard: {
account_metrics?: {
by_day: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[];
by_network: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[];
previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
ai_plan_results?: {
engagement_per_publication?: number;
engagement_vs_average?: number;
plans: number;
ranked_plans: number;
top: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[];
};
ai_plans?: {
by_state: { state?: string; total?: number }[];
credits_spent: number;
generated_publications: number;
last_plan?: {
_id: string;
creation_date: string;
credits_spent?: number;
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
prompt?: string;
publications?: string[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
pending_validation: number;
total: number;
};
available_blocks: {
account_metrics: boolean;
ai_plan_results: boolean;
ai_plans: boolean;
health: boolean;
messages: boolean;
plan_use: boolean;
publication_metrics: boolean;
publications: boolean;
};
health?: {
accounts_with_errors?: {
_id: string;
error_code: number;
image?: string;
name: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}[];
publications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[];
total_drafts?: number;
upcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[];
};
messages?: { unread: number };
plan_use?: {
actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
};
publication_metrics?: {
by_network: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
top: {
collected_date?: string;
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: (...)
| (...);
cover_image?: (...) | (...);
cover_offset?: (...) | (...);
creation_date: string;
file_externals: (...)[];
file_format: (...) | (...) | (...) | (...) | (...);
file_properties: {
allowed_social_networks: ...;
aspect_ratio: ...;
duration: ...;
height: ...;
size_in_bytes: ...;
width: ...;
};
file_type: (...)
| (...);
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
};
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
publications?: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
by_state: { state?: string; total?: number }[];
published_by_day: {
day?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
total: number;
} & { previous_total?: number };
range: {
from_date: string;
previous_from_date: string;
previous_to_date: string;
to_date: string;
};
};
DashboardDashboardAiPlanRef: {
_id: string;
creation_date: string;
credits_spent?: number;
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
prompt?: string;
publications?: string[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
DashboardDashboardPublicationRef: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
};
DashboardDashboardRange: {
from_date: string;
previous_from_date: string;
previous_to_date: string;
to_date: string;
};
DashboardMetricName: | "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
DashboardMetricRow: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
};
DashboardPlanUse: {
actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
};
DashboardPublicationsSummary: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
by_state: { state?: string; total?: number }[];
published_by_day: {
day?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
total: number;
};
DashboardTopPublication: {
collected_date?: string;
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
};
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
};
Error: { code: number; data?: { [key: string]: unknown }; message: string };
FileProperties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
IntegrationsGoogleDriveConnectRequest: {
code: string;
provider: "google_drive";
};
IntegrationsIntegration: {
_id: string;
config: {
api_base?: "wp-json"
| "rest_route";
auth_mode?: "query" | "basic";
auto_publish?: boolean;
currency?: string;
id_accounts?: string[];
import_image?: boolean;
key_ending?: string;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
tax_location_missing?: boolean;
template?: string;
url?: string;
};
connected: boolean;
creation_date: string;
enabled: boolean;
error_code?: null
| number;
external_identifier?: string;
id_client: string;
id_organization: string;
last_used_date?: string;
name: string;
provider: "google_drive" | "rss" | "woocommerce";
};
IntegrationsIntegrationCatalogPage: {
items: {
available: boolean;
description?: string;
external_id: string;
image_url?: string;
name: string;
permalink?: string;
price?: string;
}[];
next_cursor?: string;
};
IntegrationsIntegrationCatalogProduct: {
available: boolean;
description?: string;
external_id: string;
image_url?: string;
name: string;
permalink?: string;
price?: string;
};
IntegrationsIntegrationConfig: {
api_base?: "wp-json"
| "rest_route";
auth_mode?: "query" | "basic";
auto_publish?: boolean;
currency?: string;
id_accounts?: string[];
import_image?: boolean;
key_ending?: string;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
tax_location_missing?: boolean;
template?: string;
url?: string;
};
IntegrationsIntegrationFormField: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
};
IntegrationsIntegrationProvider: {
accepted_formats: string[];
catalog: boolean;
config_fields: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}[];
connect_link: boolean;
connect_link_fields: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}[];
content_feed: boolean;
file_import: boolean;
provider: "google_drive"
| "rss"
| "woocommerce";
requires_oauth: boolean;
};
IntegrationsIntegrationProviderName: "google_drive"
| "rss"
| "woocommerce";
IntegrationsRssConfig: {
auto_publish?: boolean;
id_accounts?: string[];
import_image?: boolean;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
template?: string;
url?: string;
};
IntegrationsRssConnectRequest: {
auto_publish?: boolean;
id_accounts: string[];
import_image?: boolean;
provider: "rss";
publication_type?: string;
template?: string;
url: string;
};
IntegrationsWooCommerceConnectRequest: {
consumer_key: string;
consumer_secret: string;
provider: "woocommerce";
url: string;
};
Message: {
_id: string;
contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
creation_date: string;
element_external_id?: string;
from_contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
id_account: string;
in_response_external_id?: string;
in_response_to?: string;
message_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
read: boolean;
text?: string;
};
MessageOptions: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
MessagesConversation: {
contact: {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
date: string;
unread_messages: number;
};
MessagesConversationTotals: | { total: number }
| {
group: "day" | "month" | "year";
stats: { groupValue: number; totalConversations: number }[];
};
MessagesMessageInput: {
in_response_external_id?: string;
message_options?: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
text?: string;
};
MessageType: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
NormalizedMetrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
Organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
OrganizationsLimit: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
OrganizationsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
name: string;
};
OrganizationsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}[];
total: number;
};
OrganizationsOrganizationOne: {
organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
};
OrganizationsOrganizationUpdate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
stats_settings?: { auto_refresh_twitter: boolean };
};
OrganizationsRolesOrganizationRole: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
};
OrganizationsRolesOrganizationRoleInput: {
name: string;
permissions: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
};
OrganizationsRolesOrganizationRoleList: {
roles?: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
}[];
total?: number;
};
OrganizationsRolesOrganizationRoleOne: {
rol?: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
};
};
OrganizationsRolesPermissionList: {
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
};
OrganizationsRolesUserInOrganization: {
email?: string;
enabled?: boolean;
firstname?: string;
id?: string;
lastname?: string;
roles?: { _id?: string; name?: string }[];
username?: string;
};
OrganizationsRolesUserInOrganizationList: {
total?: number;
users?: {
email?: string;
enabled?: boolean;
firstname?: string;
id?: string;
lastname?: string;
roles?: { _id?: string; name?: string }[];
username?: string;
}[];
};
OrganizationsSocialCredentialsInput: {
bot_token?: string;
client_id?: string;
client_secret?: string;
};
OrganizationsUser: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
};
OrganizationsUserList: {
total?: number;
users?: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
}[];
};
PlanData: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
PlanUseData: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ProductsProduct: {
additional_image_urls?: string[];
availability?: | "pending"
| "in stock"
| "out of stock"
| "preorder"
| "available for order"
| "discontinued"
| "mark_as_sold";
brand?: string;
category?: string;
color?: string;
condition?: | "new"
| "refurbished"
| "used"
| "used_like_new"
| "used_good"
| "used_fair"
| "cpo"
| "open_box_new";
currency: string;
description?: string;
id?: string;
image_url: string;
name: string;
price: number;
retailer_id: string;
url?: string;
} & { [key: string]: unknown };
ProductsProductCatalog: {
default_image_url?: string;
feed_count?: number;
id?: string;
is_catalog_segment?: boolean;
is_local_catalog?: boolean;
name?: string;
product_count?: number;
} & { [key: string]: unknown };
ProductsProductCatalogInput: { name: string };
ProductsProductInput: {
additional_image_urls?: string[];
availability?:
| "pending"
| "in stock"
| "out of stock"
| "preorder"
| "available for order"
| "discontinued"
| "mark_as_sold";
brand?: string;
category?: string;
color?: string;
condition?: | "new"
| "refurbished"
| "used"
| "used_like_new"
| "used_good"
| "used_fair"
| "cpo"
| "open_box_new";
currency: string;
description?: string;
id?: string;
image_url: string;
name: string;
price: number;
retailer_id: string;
url?: string;
} & { [key: string]: unknown };
Publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
PublicationAiGenerated: { image: boolean; text: boolean };
PublicationDestination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
PublicationPending: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
PublicationsDestination: {
description?: string;
id: string;
image?: string;
name: string;
privacy?: string;
sections?: { id: string; name: string }[];
};
PublicationsPublicationInput: {
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
files?: string[];
link?: string;
made_for_kids?: boolean;
name?: string;
publication_type?: "profile"
| "page"
| "group"
| "reels"
| "stories";
publish_date?: string;
reply_control?:
| "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
social_network?: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state?: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
text?: string;
title?: string;
visibility?: "public" | "unlisted" | "private";
};
PublicationsPublicationList: {
publications: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}[];
total: number;
};
PublicationsPublicationOne: {
publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
};
PublicationsPublicationRetry: {
max_retries: number;
publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
};
PublicationsPublicationsStatsList: {
metric?: string;
publications?: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: (...)
| (...)
| (...) } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}[];
range?: {
from_date?: string;
previous_from_date?: string;
previous_to_date?: string;
to_date?: string;
};
summary?: {
by_network?: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: string;
}[];
previous_total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
total?: number;
};
PublicationsPublicationStatsHistory: {
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
latest?: {
collected_date: string;
engagement_base?: "reach" | "impressions" | "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
raw?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
};
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
next_stats_update?: string;
publish_date?: string;
series: {
collected_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
}[];
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
};
PublicationsPublicationStatsPoint: {
collected_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
PublicationStats: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
SocialCredentials: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
SocialIdentifier: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
};
SocialNetwork: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
StatsSettings: { auto_refresh_twitter: boolean };
Success: { success: boolean };
Upload: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
};
UploadsUploadList: {
total: number;
uploads: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
};
UploadsUploadOne: {
upload: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
};
};
}
Account: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
AccountsAccountList: {
accounts: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}[];
total: number;
};
AccountsAccountOne: {
account: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
};
AccountsConnectSession: {
_id: string;
accounts: (
{
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
} & { already_enabled: boolean }
)[];
accounts_limit: number;
accounts_used: number;
creation_date?: string;
expires_at: string;
id_client?: string;
id_organization?: string;
keycloak_client_idenfifier?: string;
redirect_uri?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
status: "pending"
| "returned"
| "confirmed";
};
AccountsConnectSessionAccount: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
} & { already_enabled: boolean };
AccountsMetricList: (
| "reach"
| "impressions"
| "comments"
| "likes"
| "shares"
| "saves"
| "profile_views"
| "page_impressions"
| "page_total_actions"
| "page_call_phone_clicks_logged_in_unique"
| "page_get_directions_clicks_logged_in_unique"
| "page_website_clicks_logged_in_unique"
| "page_post_engagements"
| "page_consumptions_unique"
| "page_negative_feedback"
| "page_negative_feedback_unique"
| "page_fans_online_per_day"
| "page_impressions_unique"
| "page_impressions_paid"
| "page_impressions_paid_unique"
| "page_impressions_organic_v2"
| "page_impressions_organic_unique_v2"
| "page_impressions_viral"
| "page_impressions_viral_unique"
| "page_impressions_nonviral"
| "page_impressions_nonviral_unique"
| "page_posts_impressions"
| "page_posts_impressions_unique"
| "page_posts_impressions_paid"
| "page_posts_impressions_paid_unique"
| "page_posts_impressions_organic"
| "page_posts_impressions_organic_unique"
| "page_posts_served_impressions_organic_unique"
| "page_posts_impressions_viral"
| "page_posts_impressions_viral_unique"
| "page_posts_impressions_nonviral"
| "page_posts_impressions_nonviral_unique"
| "total_interactions"
| "accounts_engaged"
| "replies"
| "follows_and_unfollows"
| "profile_links_taps"
| "website_clicks"
| "paidFollowers"
| "organicFollowerGain"
| "careersPageBannerPromoClicks"
| "careersPagePromoLinksClicks"
| "careersPageEmployeesClicks"
| "careersPageJobsClicks"
| "careersPageViewsUnique"
| "careersPageViews"
| "overviewPageViewsUnique"
| "overviewPageViews"
| "allPageViews"
| "follows"
| "share"
| "views"
)[];
AccountsMetricModel: {
group: "day"
| "month"
| "year";
stats: {
date: string;
group: "day" | "month" | "year";
group_value: number;
name: string;
value: number;
}[];
};
AccountsPersistentMenu: {
call_to_actions?: { [key: string]: unknown }[];
composer_input_disabled?: boolean;
locale?: string;
}[];
AccountsSocialAuthorizationMethod: {
add_to_group_link?: string;
app_id?: string;
bot_username?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
state?: string;
type: "telegram_bot"
| "redirect"
| "meta_embedded_signup";
};
AccountsSocialLinksList: {
links: {
authorization: {
add_to_group_link?: string;
app_id?: string;
bot_username?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
state?: string;
type: "telegram_bot"
| "redirect"
| "meta_embedded_signup";
};
link: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
};
AiContext: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
AiImageOrigin: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
AiPlanResult: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
};
AiPlanResultsGroup: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
};
AiPlansAiPlan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: (...)
| (...)
| (...) } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
AiPlansAiPlanCostEstimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
AiPlansAiPlanCreateRequest: {
accounts: string[];
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
options?: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
link?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
prompt: string;
source?: {
event_date?: string;
event_name?: string;
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description: string; id_upload: string }[];
product_catalog_id?: string;
products?: string[];
text?: string;
url?: string;
};
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
};
AiPlansAiPlanCreateResponse: {
ai_plan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
estimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
estimated_cost: number;
};
AiPlansAiPlanDestination: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
};
AiPlansAiPlanList: {
ai_plans: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: ...;
id_ai_plan?: ...;
model: ...;
provider: ...;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: ...;
external_url: ...;
social_network: ...;
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: (...)[];
aspect_ratio: { text: ...; value: ... };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: (...) & (...);
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: ...]: ... };
deadline?: string;
next_check?: string;
temp_keys?: (...)[];
};
publication_errors: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: ...]: ... };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
}[];
total: number;
};
AiPlansAiPlanNotice: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
AiPlansAiPlanOne: {
ai_plan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
};
AiPlansAiPlanOptions: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
AiPlansAiPlanOptionsInput: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
link?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
AiPlansAiPlanResults: {
ai_plans: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[];
by_template: (
{
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
} & {
template: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
}
)[];
range: {
from_date: string;
previous_from_date?: string;
previous_to_date?: string;
to_date: string;
};
sort: string;
total: number;
totals: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
};
};
AiPlansAiPlanResultsTemplateGroup: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
} & {
template: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
};
AiPlansAiPlanSource: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
AiPlansAiPlanSourceImageInput: { description: string; id_upload: string };
AiPlansAiPlanSourceInput: {
event_date?: string;
event_name?: string;
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description: string; id_upload: string }[];
product_catalog_id?: string;
products?: string[];
text?: string;
url?: string;
};
AiPlansAiPlanSourceProduct: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
};
AppsClientApp: {
_id: string;
allowed_domains: string[];
creation_date: string;
deleted: boolean;
deleted_date?: string;
id_client: string;
id_user?: string;
keycloak_client_idenfifier: string;
name: string;
redirect_urls: string[];
webhook_url?: string;
};
AppsClientAppInput: {
allowed_domains?: string[];
keycloak_client_idenfifier: string;
name: string;
redirect_urls?: string[];
webhook_url?: string;
};
AppsOAuthError: {
error: | "server_error"
| "invalid_client"
| "slow_down"
| "invalid_request"
| "unsupported_grant_type";
error_description?: string;
};
AppsTokenRequest: {
client_id?: string;
client_secret?: string;
grant_type: "client_credentials";
scope?: string;
};
AppsTokenResponse: {
access_token: string;
expires_in: number;
scope?: string;
token_type: string;
};
CatalogAspectRatios: { text: string[]; values: number[] };
CatalogPlannerTemplate: {
allows_gallery?: boolean;
allows_shared?: boolean;
generates_images?: boolean;
max_source_items?: number;
orchestration_cost?: number;
orchestration_cost_per_source_item?: number;
regenerate?: { image?: boolean; text?: boolean };
source_fields?: {
default?: unknown;
max?: number;
min?: number;
name?: string;
options?: string[];
required?: boolean;
type?:
| "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "date"
| "uploads_with_description"
| "catalog_products";
}[];
source_requires_any?: string[];
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
unsupported_networks?: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
};
CatalogPlannerTemplateField: {
default?: unknown;
max?: number;
min?: number;
name?: string;
options?: string[];
required?: boolean;
type?: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "date"
| "uploads_with_description"
| "catalog_products";
};
CatalogSocialLimits: {
characters: { [key: string]: number };
comment_characters: { [key: string]: number };
max_file_size_mb: { [key: string]: number };
max_post_bytes: { [key: string]: number };
title_characters: { [key: string]: number };
total_images: { [key: string]: number };
video_duration_in_seconds: { [key: string]: number };
};
CatalogSocialLimitsMap: { [key: string]: number };
ClientsAiScopeSetting: {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter" | "openai" | "google" | "anthropic";
};
ClientsAiSettings: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
ClientsClient: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
};
ClientsClientList: {
clients: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
}[];
total: number;
};
ClientsClientOne: {
client: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
};
};
ClientsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
name: string;
};
ClientsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}[];
total: number;
};
ClientsOrganizationOne: {
organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
};
ClientsOrganizationUpdate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
stats_settings?: { auto_refresh_twitter: boolean };
};
ClientsPlan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
ClientsRolesClientPermissions: | "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read";
ClientsRolesClientPermissionsList: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
ClientsRolesClientPermissionsOne: {
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
ClientsRolesRole: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
ClientsRolesRoleInput: {
name: string;
permissions: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
| "client_organization_products:create"
| "client_organization_products:update"
| "client_organization_products:read"
| "client_organization_products:delete"
| "client_organization_messages:create"
| "client_organization_messages:read"
| "client_organization_messages:delete"
| "client_organization_contacts:create"
| "client_organization_contacts:read"
| "client_organization_contacts:update"
| "client_organization_contacts:delete"
| "client_organization_ai_plans:create"
| "client_organization_ai_plans:read"
| "client_organization_ai_plans:update"
| "client_organization_ai_plans:delete"
)[];
};
ClientsRolesRoleList: {
roles?: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
}[];
total?: number;
};
ClientsRolesRoleOne: {
rol?: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
};
ClientsRolesUser: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
};
ClientsRolesUserList: {
total?: number;
users?: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
}[];
};
CommentsAiPlanWebhookChange: {
credits_spent: number;
error?: { code: number; message: string };
field: "ai_plan_generated" | "ai_plan_failed";
id_ai_plan: string;
id_organization: string;
state: "generated" | "failed";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
total_publications: number;
warnings: number;
};
CommentsAiPlanWebhookError: { code: number; message: string };
CommentsComment: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
};
CommentsCommentActions: {
delete_others: boolean;
delete_own: boolean;
hide: boolean;
reply: boolean;
};
CommentsCommentAuthor: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
CommentsCommentNetworkName: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
CommentsCommentThread: {
comments: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
}[];
credits_consumed: number;
next_cursor?: string;
total: number;
};
CommentsIntegrationWebhookChange: {
error_code: number;
field: "integration_error";
id_integration: string;
id_organization: string;
provider: string;
};
CommentsSocialCapabilities: {
comments: boolean;
destinations: boolean;
link: boolean;
made_for_kids: boolean;
messages: boolean;
persistent_menu: boolean;
products: boolean;
publications: boolean;
reply_control: boolean;
visibility: boolean;
webhooks: boolean;
};
CommentsWebhookChange: {
commentObj?: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
};
field: | "comments"
| "messages"
| "new_account"
| "change_state_account"
| "messaging_postbacks"
| "messaging_seen"
| "messaging_error";
id_account: string;
id_contact?: string;
id_organization: string;
messageObj?: {
_id: string;
contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
creation_date: string;
element_external_id?: string;
from_contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
id_account: string;
in_response_external_id?: string;
in_response_to?: string;
message_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...)
| (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
read: boolean;
text?: string;
};
originalChange?: { [key: string]: unknown };
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
};
Contact: {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
ContactChannel: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
ContactExtraData: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
ContactsContactCreate: {
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
name?: string;
profile_image?: string;
social_identifiers: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
ContactsContactUpdate: {
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
name?: string;
profile_image?: string;
social_identifiers?: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
ContactsSocialIdentifierInput: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
};
DashboardAccountWithError: {
_id: string;
error_code: number;
image?: string;
name: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
DashboardDashboard: {
account_metrics?: {
by_day: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[];
by_network: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[];
previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
ai_plan_results?: {
engagement_per_publication?: number;
engagement_vs_average?: number;
plans: number;
ranked_plans: number;
top: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[];
};
ai_plans?: {
by_state: { state?: string; total?: number }[];
credits_spent: number;
generated_publications: number;
last_plan?: {
_id: string;
creation_date: string;
credits_spent?: number;
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
prompt?: string;
publications?: string[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
pending_validation: number;
total: number;
};
available_blocks: {
account_metrics: boolean;
ai_plan_results: boolean;
ai_plans: boolean;
health: boolean;
messages: boolean;
plan_use: boolean;
publication_metrics: boolean;
publications: boolean;
};
health?: {
accounts_with_errors?: {
_id: string;
error_code: number;
image?: string;
name: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}[];
publications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[];
total_drafts?: number;
upcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[];
};
messages?: { unread: number };
plan_use?: {
actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
};
publication_metrics?: {
by_network: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
top: {
collected_date?: string;
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: (...)
| (...);
cover_image?: (...) | (...);
cover_offset?: (...) | (...);
creation_date: string;
file_externals: (...)[];
file_format: (...) | (...) | (...) | (...) | (...);
file_properties: {
allowed_social_networks: ...;
aspect_ratio: ...;
duration: ...;
height: ...;
size_in_bytes: ...;
width: ...;
};
file_type: (...)
| (...);
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
};
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
publications?: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
by_state: { state?: string; total?: number }[];
published_by_day: {
day?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
total: number;
} & { previous_total?: number };
range: {
from_date: string;
previous_from_date: string;
previous_to_date: string;
to_date: string;
};
};
DashboardDashboardAiPlanRef: {
_id: string;
creation_date: string;
credits_spent?: number;
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
prompt?: string;
publications?: string[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
DashboardDashboardPublicationRef: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
};
DashboardDashboardRange: {
from_date: string;
previous_from_date: string;
previous_to_date: string;
to_date: string;
};
DashboardMetricName: | "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
DashboardMetricRow: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
};
DashboardPlanUse: {
actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
};
DashboardPublicationsSummary: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
by_state: { state?: string; total?: number }[];
published_by_day: {
day?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
total: number;
};
DashboardTopPublication: {
collected_date?: string;
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
};
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
};
Error: { code: number; data?: { [key: string]: unknown }; message: string };
FileProperties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
IntegrationsGoogleDriveConnectRequest: {
code: string;
provider: "google_drive";
};
IntegrationsIntegration: {
_id: string;
config: {
api_base?: "wp-json"
| "rest_route";
auth_mode?: "query" | "basic";
auto_publish?: boolean;
currency?: string;
id_accounts?: string[];
import_image?: boolean;
key_ending?: string;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
tax_location_missing?: boolean;
template?: string;
url?: string;
};
connected: boolean;
creation_date: string;
enabled: boolean;
error_code?: null
| number;
external_identifier?: string;
id_client: string;
id_organization: string;
last_used_date?: string;
name: string;
provider: "google_drive" | "rss" | "woocommerce";
};
IntegrationsIntegrationCatalogPage: {
items: {
available: boolean;
description?: string;
external_id: string;
image_url?: string;
name: string;
permalink?: string;
price?: string;
}[];
next_cursor?: string;
};
IntegrationsIntegrationCatalogProduct: {
available: boolean;
description?: string;
external_id: string;
image_url?: string;
name: string;
permalink?: string;
price?: string;
};
IntegrationsIntegrationConfig: {
api_base?: "wp-json"
| "rest_route";
auth_mode?: "query" | "basic";
auto_publish?: boolean;
currency?: string;
id_accounts?: string[];
import_image?: boolean;
key_ending?: string;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
tax_location_missing?: boolean;
template?: string;
url?: string;
};
IntegrationsIntegrationFormField: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
};
IntegrationsIntegrationProvider: {
accepted_formats: string[];
catalog: boolean;
config_fields: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}[];
connect_link: boolean;
connect_link_fields: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}[];
content_feed: boolean;
file_import: boolean;
provider: "google_drive"
| "rss"
| "woocommerce";
requires_oauth: boolean;
};
IntegrationsIntegrationProviderName: "google_drive"
| "rss"
| "woocommerce";
IntegrationsRssConfig: {
auto_publish?: boolean;
id_accounts?: string[];
import_image?: boolean;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
template?: string;
url?: string;
};
IntegrationsRssConnectRequest: {
auto_publish?: boolean;
id_accounts: string[];
import_image?: boolean;
provider: "rss";
publication_type?: string;
template?: string;
url: string;
};
IntegrationsWooCommerceConnectRequest: {
consumer_key: string;
consumer_secret: string;
provider: "woocommerce";
url: string;
};
Message: {
_id: string;
contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
creation_date: string;
element_external_id?: string;
from_contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
id_account: string;
in_response_external_id?: string;
in_response_to?: string;
message_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
read: boolean;
text?: string;
};
MessageOptions: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
MessagesConversation: {
contact: {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
date: string;
unread_messages: number;
};
MessagesConversationTotals: | { total: number }
| {
group: "day" | "month" | "year";
stats: { groupValue: number; totalConversations: number }[];
};
MessagesMessageInput: {
in_response_external_id?: string;
message_options?: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
text?: string;
};
MessageType: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
NormalizedMetrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
Organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
OrganizationsLimit: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
OrganizationsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
name: string;
};
OrganizationsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}[];
total: number;
};
OrganizationsOrganizationOne: {
organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
};
OrganizationsOrganizationUpdate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
stats_settings?: { auto_refresh_twitter: boolean };
};
OrganizationsRolesOrganizationRole: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
};
OrganizationsRolesOrganizationRoleInput: {
name: string;
permissions: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
};
OrganizationsRolesOrganizationRoleList: {
roles?: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
}[];
total?: number;
};
OrganizationsRolesOrganizationRoleOne: {
rol?: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
};
};
OrganizationsRolesPermissionList: {
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
};
OrganizationsRolesUserInOrganization: {
email?: string;
enabled?: boolean;
firstname?: string;
id?: string;
lastname?: string;
roles?: { _id?: string; name?: string }[];
username?: string;
};
OrganizationsRolesUserInOrganizationList: {
total?: number;
users?: {
email?: string;
enabled?: boolean;
firstname?: string;
id?: string;
lastname?: string;
roles?: { _id?: string; name?: string }[];
username?: string;
}[];
};
OrganizationsSocialCredentialsInput: {
bot_token?: string;
client_id?: string;
client_secret?: string;
};
OrganizationsUser: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
};
OrganizationsUserList: {
total?: number;
users?: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
}[];
};
PlanData: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
PlanUseData: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ProductsProduct: {
additional_image_urls?: string[];
availability?: | "pending"
| "in stock"
| "out of stock"
| "preorder"
| "available for order"
| "discontinued"
| "mark_as_sold";
brand?: string;
category?: string;
color?: string;
condition?: | "new"
| "refurbished"
| "used"
| "used_like_new"
| "used_good"
| "used_fair"
| "cpo"
| "open_box_new";
currency: string;
description?: string;
id?: string;
image_url: string;
name: string;
price: number;
retailer_id: string;
url?: string;
} & { [key: string]: unknown };
ProductsProductCatalog: {
default_image_url?: string;
feed_count?: number;
id?: string;
is_catalog_segment?: boolean;
is_local_catalog?: boolean;
name?: string;
product_count?: number;
} & { [key: string]: unknown };
ProductsProductCatalogInput: { name: string };
ProductsProductInput: {
additional_image_urls?: string[];
availability?:
| "pending"
| "in stock"
| "out of stock"
| "preorder"
| "available for order"
| "discontinued"
| "mark_as_sold";
brand?: string;
category?: string;
color?: string;
condition?: | "new"
| "refurbished"
| "used"
| "used_like_new"
| "used_good"
| "used_fair"
| "cpo"
| "open_box_new";
currency: string;
description?: string;
id?: string;
image_url: string;
name: string;
price: number;
retailer_id: string;
url?: string;
} & { [key: string]: unknown };
Publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
PublicationAiGenerated: { image: boolean; text: boolean };
PublicationDestination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
PublicationPending: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
PublicationsDestination: {
description?: string;
id: string;
image?: string;
name: string;
privacy?: string;
sections?: { id: string; name: string }[];
};
PublicationsPublicationInput: {
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
files?: string[];
link?: string;
made_for_kids?: boolean;
name?: string;
publication_type?: "profile"
| "page"
| "group"
| "reels"
| "stories";
publish_date?: string;
reply_control?:
| "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
social_network?: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state?: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
text?: string;
title?: string;
visibility?: "public" | "unlisted" | "private";
};
PublicationsPublicationList: {
publications: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}[];
total: number;
};
PublicationsPublicationOne: {
publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
};
PublicationsPublicationRetry: {
max_retries: number;
publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
};
PublicationsPublicationsStatsList: {
metric?: string;
publications?: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: (...)
| (...)
| (...) } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}[];
range?: {
from_date?: string;
previous_from_date?: string;
previous_to_date?: string;
to_date?: string;
};
summary?: {
by_network?: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: string;
}[];
previous_total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
total?: number;
};
PublicationsPublicationStatsHistory: {
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
latest?: {
collected_date: string;
engagement_base?: "reach" | "impressions" | "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
raw?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
};
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
next_stats_update?: string;
publish_date?: string;
series: {
collected_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
}[];
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
};
PublicationsPublicationStatsPoint: {
collected_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
PublicationStats: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
SocialCredentials: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
SocialIdentifier: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
};
SocialNetwork: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
StatsSettings: { auto_refresh_twitter: boolean };
Success: { success: boolean };
Upload: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
};
UploadsUploadList: {
total: number;
uploads: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
};
UploadsUploadOne: {
upload: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
};
};
}
Type declaration
Account: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}Description
A social account connected to an organization.
On `discord`, on `telegram` and on `slack` an account is a **channel**, not a profile: publishing to two Discord channels of the same server — or to two Telegram channels of the same brand, or to `#anuncios` and `#general` of the same Slack workspace — costs two accounts of the plan. On `linkedin` one authorization brings two kinds of account: the **personal profile** of whoever authorizes and each **page** they manage. Both publish and both have statistics, but only pages have a comment inbox: LinkedIn does not let any app read the comments on a member's posts, so on a profile every comment endpoint returns error `2600`. `extra_data.is_personal_profile` tells them apart. `error_code` other than `0` means the connection is broken — an expired token, a permission taken away — and the account has to be connected again. On `telegram` nothing expires, because there is no account token: what breaks the connection is the bot being removed from the channel or losing its permission to post there (error 968). On `slack` the bot token does not expire either: what breaks it is the app being removed from the channel (error 980) or the channel being archived or deleted (error 985)._id: string
creation_date: string
Format: date-time
error_code: number
Optionalextra_data?: { is_personal_profile?: boolean } & { [key: string]: unknown }Optionalfollowers_count?: numberDescription
Followers the network reports. Absent on an account that has never been measured. On
telegramand onslackit is the channel's member count, and it is the only audience figure either network publishes: there are no views, no impressions and no reach anywhere in the Bot API nor in the Slack Web API.id_client: string
id_organization: string
Optionalimage?: stringname: string
Optionalnext_comments_update?: stringFormat: date-time
Optionalnext_stats_update?: stringFormat: date-time
Optionalprivate_message_link?: stringsocial_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"Optionalusername?: stringDescription
The handle, when the network has one. Absent on the networks that do not (a Discord channel, a WhatsApp number, a Google Business listing) and on a private Telegram channel, which has no
@nameat all — only public ones do. That is also why a private channel's publications come back with nourl.
AccountsAccountList: {
accounts: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}[];
total: number;
}AccountsAccountOne: {
account: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
}account: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}_id: string
creation_date: string
Format: date-time
error_code: number
Optionalextra_data?: { is_personal_profile?: boolean } & { [key: string]: unknown }Optionalfollowers_count?: numberDescription
Followers the network reports. Absent on an account that has never been measured. On
telegramand onslackit is the channel's member count, and it is the only audience figure either network publishes: there are no views, no impressions and no reach anywhere in the Bot API nor in the Slack Web API.id_client: string
id_organization: string
Optionalimage?: stringname: string
Optionalnext_comments_update?: stringFormat: date-time
Optionalnext_stats_update?: stringFormat: date-time
Optionalprivate_message_link?: stringsocial_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"Optionalusername?: stringDescription
The handle, when the network has one. Absent on the networks that do not (a Discord channel, a WhatsApp number, a Google Business listing) and on a private Telegram channel, which has no
@nameat all — only public ones do. That is also why a private channel's publications come back with nourl.
AccountsConnectSession: {
_id: string;
accounts: (
{
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
} & { already_enabled: boolean }
)[];
accounts_limit: number;
accounts_used: number;
creation_date?: string;
expires_at: string;
id_client?: string;
id_organization?: string;
keycloak_client_idenfifier?: string;
redirect_uri?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
status: "pending"
| "returned"
| "confirmed";
}_id: string
accounts: (
{
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
} & { already_enabled: boolean }
)[]accounts_limit: number
accounts_used: number
Optionalcreation_date?: stringFormat: date-time
expires_at: string
Format: date-time
Optionalid_client?: stringOptionalid_organization?: stringOptionalkeycloak_client_idenfifier?: stringOptionalredirect_uri?: stringsocial_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"status: "pending" | "returned" | "confirmed"
AccountsConnectSessionAccount: {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
} & { already_enabled: boolean }AccountsMetricList: (
| "reach"
| "impressions"
| "comments"
| "likes"
| "shares"
| "saves"
| "profile_views"
| "page_impressions"
| "page_total_actions"
| "page_call_phone_clicks_logged_in_unique"
| "page_get_directions_clicks_logged_in_unique"
| "page_website_clicks_logged_in_unique"
| "page_post_engagements"
| "page_consumptions_unique"
| "page_negative_feedback"
| "page_negative_feedback_unique"
| "page_fans_online_per_day"
| "page_impressions_unique"
| "page_impressions_paid"
| "page_impressions_paid_unique"
| "page_impressions_organic_v2"
| "page_impressions_organic_unique_v2"
| "page_impressions_viral"
| "page_impressions_viral_unique"
| "page_impressions_nonviral"
| "page_impressions_nonviral_unique"
| "page_posts_impressions"
| "page_posts_impressions_unique"
| "page_posts_impressions_paid"
| "page_posts_impressions_paid_unique"
| "page_posts_impressions_organic"
| "page_posts_impressions_organic_unique"
| "page_posts_served_impressions_organic_unique"
| "page_posts_impressions_viral"
| "page_posts_impressions_viral_unique"
| "page_posts_impressions_nonviral"
| "page_posts_impressions_nonviral_unique"
| "total_interactions"
| "accounts_engaged"
| "replies"
| "follows_and_unfollows"
| "profile_links_taps"
| "website_clicks"
| "paidFollowers"
| "organicFollowerGain"
| "careersPageBannerPromoClicks"
| "careersPagePromoLinksClicks"
| "careersPageEmployeesClicks"
| "careersPageJobsClicks"
| "careersPageViewsUnique"
| "careersPageViews"
| "overviewPageViewsUnique"
| "overviewPageViews"
| "allPageViews"
| "follows"
| "share"
| "views"
)[]AccountsMetricModel: {
group: "day" | "month" | "year";
stats: {
date: string;
group: "day" | "month" | "year";
group_value: number;
name: string;
value: number;
}[];
}group: "day" | "month" | "year"
stats: {
date: string;
group: "day" | "month" | "year";
group_value: number;
name: string;
value: number;
}[]
AccountsPersistentMenu: {
call_to_actions?: { [key: string]: unknown }[];
composer_input_disabled?: boolean;
locale?: string;
}[]AccountsSocialAuthorizationMethod: {
add_to_group_link?: string;
app_id?: string;
bot_username?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
state?: string;
type: "telegram_bot" | "redirect" | "meta_embedded_signup";
}Description
How an account of this network is authorized, which is not always "send the user to this URL".
Almost every network is `redirect`: open `link` and the network sends the person back to PlanVortex with a code. Two are not: • **WhatsApp.** Its sign-up is Meta's *Embedded Signup*: a popup raised by the Facebook JavaScript SDK from your own page, which returns — over `postMessage` — session data (`waba_id`, `phone_number_id`) that no query string carries. Its `link` is therefore an empty string. • **Telegram.** There is no OAuth here: no consent screen, no `code`, no account token. `link` opens a private chat with the PlanVortex bot, the person then adds that bot to their channel, and **the account is created from that event**, not from any request of yours. Which means the connection cannot be finished by calling `GET /organizations/{id_organization}/account-connect/telegram` — see that endpoint. Branch on `authorization.type`, never on whether `link` is empty.Optionaladd_to_group_link?: stringDescription
telegram_botonly. The second step, and it does not follow from the first:linkopens the list of channels and this one opens the list of groups. It adds the bot to the channel's linked discussion group, which is what turns comments on — a Telegram channel with no discussion group has no comment inbox at all (error 965). Optional for the user: publishing and statistics work without it.Optionalapp_id?: stringOptionalbot_username?: stringOptionalconfig_id?: stringOptionalfeature_type?: stringOptionalgraph_version?: stringOptionalsession_info_version?: stringOptionalstate?: stringtype: "telegram_bot" | "redirect" | "meta_embedded_signup"
AccountsSocialLinksList: {
links: {
authorization: {
add_to_group_link?: string;
app_id?: string;
bot_username?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
state?: string;
type: "telegram_bot" | "redirect" | "meta_embedded_signup";
};
link: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
}links: {
authorization: {
add_to_group_link?: string;
app_id?: string;
bot_username?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
state?: string;
type: "telegram_bot" | "redirect" | "meta_embedded_signup";
};
link: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[]
AiContext: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
}Optionalaudience?: stringOptionalavoid?: stringOptionalblog_url?: stringOptionalbrand_name?: stringOptionaldefault_tone?: stringOptionaldescription?: stringOptionalkeywords?: string[]Optionalnotes?: stringOptionalproducts?: stringOptionalsector?: stringOptionalshop_url?: stringOptionalsocial_urls?: string[]Optionalvalue_proposition?: stringOptionalwebsite?: string
AiImageOrigin: { generated_at: string; id_ai_plan?: string; model: string; provider: string }
Description
Where an AI-generated image came from. Only images a model generated carry it: a photo the organization uploaded, a product photo pulled from a connected shop or an image imported from an integration never does.
It is set when the image is generated and cannot be edited. Use it to show your own AI label: under article 50(4) of the EU AI Act, telling the audience that an image is AI-generated is the job of whoever publishes it. Images made with the default model also carry a signed C2PA manifest, IPTC metadata and a SynthID watermark in the file itself. PlanVortex keeps the IPTC marker when it crops or recompresses an image for a network; the C2PA signature does not survive a change of pixels.generated_at: string
Format: date-time
Optionalid_ai_plan?: stringmodel: string
provider: string
AiPlanResult: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}Description
What ONE AI plan achieved with what it published.
**Where the numbers come from.** A plan keeps its publications, and each publication keeps the last known value of its metrics (the same ones `GET /organizations/{id}/publications/stats` returns). This adds those up — nothing here is measured twice or asked to the network again. **Only the publications that went out and were measured count** (`publications.measured`). A post scheduled for tomorrow, one that failed or one published an hour ago that nobody has measured yet does not lower the average: it is simply not in it. **A missing metric is not a zero**, as everywhere else: if no publication of the plan reports `reach`, the plan has no `reach` key.accounts: number
Optionalarchived_date?: stringFormat: date-time
creation_date: string
Format: date-time
Optionalcredits_per_engagement?: numberDescription
AI credits per interaction: what each interaction cost. Lower is better. Absent with no interactions, with no credits spent (your own AI key) and whenever
social_networkis filtered — the cost belongs to the whole plan, and dividing it by one network's interactions would overprice every one of them.credits_spent: number
Optionalengagement_per_publication?: numberDescription
Interactions per measured publication — the number plans are ranked by. The total rewards size (seven accounts for seven days beat one account even if each post does half as well), and the engagement rate divides by reach on some networks and by followers on others, which makes two plans on different networks incomparable. Absent when nothing is measured yet.
Optionalengagement_vs_average?: numberDescription
engagement_per_publicationdivided byexpected_engagement_per_publication: 1 means like your average, 2 twice as much, 0.5 half. This is the number that says whether a plan is good, not just first — the ranking still orders byengagement_per_publication, so the first plan can be below 1. Absent with nothing measured or no average to compare with.Optionalexpected_engagement_per_publication?: numberDescription
What your usual posts would get with the same mix of networks: the organization's average interactions per measured post on each network, weighted by how many measured posts the plan has there. Two measured posts on Instagram (average 5) and two on LinkedIn (average 1) expect (2·5 + 2·1) / 4 = 3.
The average covers **every** measured post of the organization in the range, AI ones included, on the same networks. Weighting by network is what keeps a LinkedIn-only plan from always reading as below average just because LinkedIn moves less than Instagram.id_ai_plan: string
id_organization: string
Optionallast_publish_date?: stringFormat: date-time
maturing: boolean
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
prompt: string
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
}failed: number
measured: number
published: number
scheduled: number
total: number
ranked: boolean
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[]state: "generated" | "validated"
template: "standard" | "from_images" | "from_text" | "from_catalog" | "campaign"
week_start: string
Format: date-time
AiPlanResultsGroup: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
}Optionalcredits_per_engagement?: numbercredits_spent: number
Optionalengagement_per_publication?: numberOptionalengagement_vs_average?: numberOptionalexpected_engagement_per_publication?: numbermetrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
plans: number
publications: { measured: number; published: number }
ranked_plans: number
AiPlansAiPlan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: (...)
| (...)
| (...) } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
}_id: string
accounts: string[]
Optionalarchived_date?: stringFormat: date-time
Description
When the plan was archived. Absent means it is active, which is how every plan created before archiving existed comes back.
It is a field of its own and NOT a value of `state` on purpose: `state` is the generation lifecycle and archiving is orthogonal to it — a `validated` plan that already published gets archived just like a `failed` one. Inside the enum you would have to decide which state it returns to when unarchived, and that question has no answer. Archiving is visibility only: it takes the plan out of the default listing and touches no publication. Anything it had scheduled keeps publishing.attempts: number
creation_date: string
Format: date-time
credits_spent: number
Optionaldestinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[]Optionalerror?: { code: number; data?: { [key: string]: unknown }; message: string }Optionalgeneration_end_date?: stringFormat: date-time
id_client: string
id_organization: string
Optionalkeycloak_identifier?: stringoptions: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
}allow_images: boolean
gallery_uploads: string[]
language: string
Optionallink?: stringOptionalmax_images?: numberpublish_days: number[]
Description
Days of the week the plan publishes on, in ISO 8601 numbering (1 = Monday ... 7 = Sunday). Defaults to the whole week. There is still at most ONE publication per day and account, so this is what bounds the size and the cost of the plan: the number of generated posts is (selected days x accounts). Must be a non-empty array of unique integers between 1 and 7, or the request is rejected with 2106. The 7-day window starts at week_start, so each ISO day appears exactly once: with a week_start in mid-week, day 1 (Monday) is the FOLLOWING Monday. If the selected days leave no future slot at all, the request is rejected with 2108.
shared: boolean
timezone: string
Optionaltone?: stringuse_organization_context: boolean
week_start: string
Format: date-time
Optionalorchestrator_result?: Record<string, never>Optionalorganization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
}Optionalaudience?: stringOptionalavoid?: stringOptionalblog_url?: stringOptionalbrand_name?: stringOptionaldefault_tone?: stringOptionaldescription?: stringOptionalkeywords?: string[]Optionalnotes?: stringOptionalproducts?: stringOptionalsector?: stringOptionalshop_url?: stringOptionalsocial_urls?: string[]Optionalvalue_proposition?: stringOptionalwebsite?: string
prompt: string
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: (...)
| (...)
| (...) } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[]Optionalsource?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
}Optionalevent?: { date?: string; name?: string }Optionaldate?: stringFormat: date-time
Optionalname?: string
Optionalid_account_catalog?: stringOptionalid_integration_catalog?: stringOptionalimages?: { description?: string; id_upload?: string }[]Optionalproducts?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[]Optionaltext?: stringOptionalurl?: string
state: "pending" | "generating" | "generated" | "validated" | "failed" | "cancelled"
Optionaltemplate?: "standard" | "from_images" | "from_text" | "from_catalog" | "campaign"Optionalwarnings?: { code: number; data?: { [key: string]: unknown }; message: string }[]Description
Non-blocking notices about the LAST attempt (they are cleared when a new one starts). The plan is generated and perfectly usable; your UI just has to say what happened.
Today there are two. **2117 — some source items did not fit in the plan week.** A plan is weekly and the source does not extend it, so 12 photos with 6 slots left publish 6 and the rest are dropped. `data` carries `{ source_items, capacity }`. Better said BEFORE creating the plan (the slots are the publish days x the accounts) than after charging for it. **922 — a publication of a network that cannot publish without an image was left without one.** On Pinterest a pin is an image or a video, never text. The plan cannot be created with a configuration that would cause this (2119), but an image generation that fails halfway through the plan cannot be foreseen. `data` carries `{ step, social_network, id_account, id_publication }`: that draft will not publish until it has an image — regenerate it or attach one.
AiPlansAiPlanCostEstimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
}available_credits: number
base_cost: number
Description
Mandatory cost (orchestration + target texts). The orchestration half depends on the TEMPLATE and on the size of its source:
orchestration_cost+orchestration_cost_per_source_itemx units, both published inGET /planner_templates. The plan is rejected if this exceeds the available credits.estimated_cost: number
images_target: number
Description
How many images the plan will generate. 0 when the template does not generate them (
from_images,from_catalog): the pictures come from the source, so the plan spends no image credits at all — a week of 7 publications with a picture on each goes from 519 credits to 48. That is worth saying out loud before the plan is created.texts_target: number
AiPlansAiPlanCreateRequest: {
accounts: string[];
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
options?: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
link?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
prompt: string;
source?: {
event_date?: string;
event_name?: string;
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description: string; id_upload: string }[];
product_catalog_id?: string;
products?: string[];
text?: string;
url?: string;
};
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
}accounts: string[]
Optionaldestinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[]Description
Where each account publishes, for the networks that answer
destinations: trueinGET /social_capabilities— todaypinterestalone, where it is the board of every pin of that account.**On Pinterest it is required, one entry per Pinterest account of the plan.** A plan without it — or with a board id that is not a string of digits — is rejected with **2118**, listing EVERY account that fails in `data.accounts[]` with the same `reason` as the publication's 987 (`missing`, `invalid_id`, `invalid_section_id`), so your UI can mark them all at once. Without this check the plan would be created, charged, and leave a week of drafts in `withErrors` with the 987. Entries for accounts on networks without destinations are dropped, not rejected. The board is **not** checked against Pinterest at creation — that would make creating a plan depend on Pinterest answering; a board that does not exist fails when the pin is published. Read the account's boards with `GET /organizations/{id_organization}/accounts/{id_account}/destinations`.Optionaloptions?: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
link?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
}Optionalallow_images?: booleanOptionalgallery_uploads?: string[]Description
Upload ids from the organization's gallery used as visual reference for the generated images. They are references for the images the model GENERATES, so a template that does not generate them does not accept them either (
allows_gallery): sending them tofrom_imagesorfrom_catalogis a 2106.Optionallanguage?: stringOptionallink?: stringDescription
The destination link of the plan's publications — the pin's
link, the same for every publication of the plan. Optional: a pin without a link is legitimate, it just takes nobody anywhere. Onfrom_catalog, each pin leads to its product's page (permalink) when this is absent; when it is present, it wins.It only reaches the publications of the networks that answer `link: true` in `GET /social_capabilities` (today `pinterest`); with none of them in the plan it is dropped. With one, it is validated **at creation**: a URL Pinterest would reject is a **994** now (`data.reason` `invalid_url` or `too_long`), not a week of pins failing at publish time.Optionalmax_images?: numberOptionalpublish_days?: number[]Description
Days of the week the plan publishes on, in ISO 8601 numbering (1 = Monday ... 7 = Sunday). Defaults to the whole week. There is still at most ONE publication per day and account, so this is what bounds the size and the cost of the plan: the number of generated posts is (selected days x accounts). Must be a non-empty array of unique integers between 1 and 7, or the request is rejected with 2106. The 7-day window starts at week_start, so each ISO day appears exactly once: with a week_start in mid-week, day 1 (Monday) is the FOLLOWING Monday. If the selected days leave no future slot at all, the request is rejected with 2108. Optional; defaults to
[1,2,3,4,5,6,7].Optionalshared?: booleanDescription
Generate ONE piece of content per day and replicate it across every account, each scheduled at the best hour for ITS network, instead of one publication per account and day. Cheaper — one text and one image per day — and it caps images at 7. Optional; defaults to
false. Not every template accepts it (allows_sharedinGET /planner_templates):from_imagesandfrom_catalogdo not, because each of their publications carries a photo of its own, and sendingtrueto them is rejected with 2106.Optionaltimezone?: stringOptionaltone?: stringOptionaluse_organization_context?: booleanOptionalweek_start?: stringFormat: date-time
prompt: string
Optionalsource?: {
event_date?: string;
event_name?: string;
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description: string; id_upload: string }[];
product_catalog_id?: string;
products?: string[];
text?: string;
url?: string;
}Optionalevent_date?: stringFormat: date
Description
campaign. The day of the event. Send a calendar day,YYYY-MM-DD— never an ISO instant. A bare date is read in the plan'soptions.timezone, which is the whole point:2026-09-15T00:00:00Zis midnight UTC, that is the 14th in the afternoon in New York — a whole day off in a countdown, for half of America, with no error anywhere. It cannot fall before the plan week (options.week_start) nor more than 60 days after it (2112). And it does not movepublish_days: if the event lands on a day you did not choose, the plan respects your choice and it is up to you to say so.Optionalevent_name?: stringOptionalid_account_catalog?: stringDescription
from_catalog, from a Meta catalogue. Which account's catalogue the products come from. It has to belong to the organization (2103) and be on a network that supports products (2115). It only chooses the catalogue: the publications still go to every account inaccounts— a LinkedIn account can publish a product from a Facebook catalogue. Exclusive withid_integration_catalog(both at once is a 2112).Optionalid_integration_catalog?: stringDescription
from_catalog, from a connected store. An integration of the organization whose provider hascatalog: true(a WooCommerce store), enabled; another organization's is a 2200, without confirming it exists. The products are itsexternal_ids, fromGET .../integrations/{id_integration}/products. Like the account, it only chooses the catalogue: the publications go to every account inaccounts. Exclusive withid_account_catalog.Optionalimages?: { description: string; id_upload: string }[]Description
from_images. Your own photos, each with its own description, in the order that tells the story: the orchestrator picks one per publication and keeps its position insource_index, so photo 3 can be the "before" and photo 7 the "after". Up to 20 (max_source_items), and each one has to be an image upload of this organization (806 otherwise).Optionalproduct_catalog_id?: stringOptionalproducts?: string[]Description
from_catalog. Ids of the chosen products, in the order they should tell the week. Up to 12 — a unit here is not an id already in the database: it is a live read plus a real download inside this request, with the user waiting. Repeated ids are deduplicated. They are ALL checked against the catalogue before a single picture is downloaded (2112 naming the missing one, or the one that is out of stock), and each picture is copied into an upload of the organization: a catalogue's picture URL expires or changes, and a plan published weeks later would carry a broken file. Those uploads count against the storage quota.Optionaltext?: stringDescription
from_text. The article pasted by hand. It wins overurlwhen both come: pasting is what a user does when the download did not work (a paywall, a page that needs JavaScript), so re-downloading to ignore what they wrote would take away their only way out. Truncated to 12.000 characters — the cap is what keeps the estimate honest, since the real charge is per use. Under 200 characters it is not an article, it is the theme, which ispromptand another field (2116).Optionalurl?: stringFormat: uri
Description
from_text. The article the plan is written from. It is downloaded at creation, and onlyhttp/httpsaddresses that resolve to a public IP are accepted — checked again before every redirect (2114). A page that answers something that is not text or HTML, or that carries no usable text once stripped, is a 2113: paste the text intextinstead.
Optionaltemplate?: "standard" | "from_images" | "from_text" | "from_catalog" | "campaign"Description
What the plan is generated FROM. Optional; defaults to
standard, which is exactly what every plan did before templates existed — send nothing and nothing changes.A template is the **source** of the content, not a different flow: `shared`, `publish_days`, `language`, `tone` and the images stay cross-cutting options, and each template declares which of them it accepts. Sending one it does not accept is a 2106, not a silent ignore. Read the list, the costs and the fields from `GET /planner_templates`; do not hardcode them.
AiPlansAiPlanCreateResponse: {
ai_plan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
estimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
estimated_cost: number;
}ai_plan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
}_id: string
accounts: string[]
Optionalarchived_date?: stringFormat: date-time
Description
When the plan was archived. Absent means it is active, which is how every plan created before archiving existed comes back.
It is a field of its own and NOT a value of `state` on purpose: `state` is the generation lifecycle and archiving is orthogonal to it — a `validated` plan that already published gets archived just like a `failed` one. Inside the enum you would have to decide which state it returns to when unarchived, and that question has no answer. Archiving is visibility only: it takes the plan out of the default listing and touches no publication. Anything it had scheduled keeps publishing.attempts: number
creation_date: string
Format: date-time
credits_spent: number
Optionaldestinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[]Optionalerror?: { code: number; data?: { [key: string]: unknown }; message: string }Optionalgeneration_end_date?: stringFormat: date-time
id_client: string
id_organization: string
Optionalkeycloak_identifier?: stringoptions: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
}allow_images: boolean
gallery_uploads: string[]
language: string
Optionallink?: stringOptionalmax_images?: numberpublish_days: number[]
Description
Days of the week the plan publishes on, in ISO 8601 numbering (1 = Monday ... 7 = Sunday). Defaults to the whole week. There is still at most ONE publication per day and account, so this is what bounds the size and the cost of the plan: the number of generated posts is (selected days x accounts). Must be a non-empty array of unique integers between 1 and 7, or the request is rejected with 2106. The 7-day window starts at week_start, so each ISO day appears exactly once: with a week_start in mid-week, day 1 (Monday) is the FOLLOWING Monday. If the selected days leave no future slot at all, the request is rejected with 2108.
shared: boolean
timezone: string
Optionaltone?: stringuse_organization_context: boolean
week_start: string
Format: date-time
Optionalorchestrator_result?: Record<string, never>Optionalorganization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
}Optionalaudience?: stringOptionalavoid?: stringOptionalblog_url?: stringOptionalbrand_name?: stringOptionaldefault_tone?: stringOptionaldescription?: stringOptionalkeywords?: string[]Optionalnotes?: stringOptionalproducts?: stringOptionalsector?: stringOptionalshop_url?: stringOptionalsocial_urls?: string[]Optionalvalue_proposition?: stringOptionalwebsite?: string
prompt: string
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[]Optionalsource?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
}Optionalevent?: { date?: string; name?: string }Optionaldate?: stringFormat: date-time
Optionalname?: string
Optionalid_account_catalog?: stringOptionalid_integration_catalog?: stringOptionalimages?: { description?: string; id_upload?: string }[]Optionalproducts?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[]Optionaltext?: stringOptionalurl?: string
state: "pending" | "generating" | "generated" | "validated" | "failed" | "cancelled"
Optionaltemplate?: "standard" | "from_images" | "from_text" | "from_catalog" | "campaign"Optionalwarnings?: { code: number; data?: { [key: string]: unknown }; message: string }[]Description
Non-blocking notices about the LAST attempt (they are cleared when a new one starts). The plan is generated and perfectly usable; your UI just has to say what happened.
Today there are two. **2117 — some source items did not fit in the plan week.** A plan is weekly and the source does not extend it, so 12 photos with 6 slots left publish 6 and the rest are dropped. `data` carries `{ source_items, capacity }`. Better said BEFORE creating the plan (the slots are the publish days x the accounts) than after charging for it. **922 — a publication of a network that cannot publish without an image was left without one.** On Pinterest a pin is an image or a video, never text. The plan cannot be created with a configuration that would cause this (2119), but an image generation that fails halfway through the plan cannot be foreseen. `data` carries `{ step, social_network, id_account, id_publication }`: that draft will not publish until it has an image — regenerate it or attach one.
estimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
}available_credits: number
base_cost: number
Description
Mandatory cost (orchestration + target texts). The orchestration half depends on the TEMPLATE and on the size of its source:
orchestration_cost+orchestration_cost_per_source_itemx units, both published inGET /planner_templates. The plan is rejected if this exceeds the available credits.estimated_cost: number
images_target: number
Description
How many images the plan will generate. 0 when the template does not generate them (
from_images,from_catalog): the pictures come from the source, so the plan spends no image credits at all — a week of 7 publications with a picture on each goes from 519 credits to 48. That is worth saying out loud before the plan is created.texts_target: number
estimated_cost: number
AiPlansAiPlanDestination: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}Description
The destination of ONE account of the plan: the Pinterest board where all of that account's publications of the plan go.
One per ACCOUNT, not one per plan, because a plan can carry three Pinterest profiles and each one has its own boards. And it travels with the account, not with the content: in a `shared` plan the same content replicated to three profiles lands on three boards with nothing else to touch. There is no default destination stored on the account: it lives in the plan alone.destination: { id?: string; name?: string; section_id?: string; section_name?: string }
Optionalid?: stringDescription
The board id. Always a string, never a number: Pinterest's ids are long integers, so a client that sends one as a JSON number has already lost digits to rounding before the request arrives. That is refused —
publication_errors[].code = 987withdata.reason = "invalid_id"— rather than published to some other board. Sending the board's name instead of its id fails the same way, which is the likeliest first mistake of an integration.Optionalname?: stringOptionalsection_id?: stringOptionalsection_name?: string
id_account: string
AiPlansAiPlanList: {
ai_plans: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: ...;
id_ai_plan?: ...;
model: ...;
provider: ...;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: ...;
external_url: ...;
social_network: ...;
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: (...)[];
aspect_ratio: { text: ...; value: ... };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: (...) & (...);
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: ...]: ... };
deadline?: string;
next_check?: string;
temp_keys?: (...)[];
};
publication_errors: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: ...]: ... };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
}[];
total: number;
}AiPlansAiPlanNotice: { code: number; data?: { [key: string]: unknown }; message: string }
AiPlansAiPlanOne: {
ai_plan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
};
}ai_plan: {
_id: string;
accounts: string[];
archived_date?: string;
attempts: number;
creation_date: string;
credits_spent: number;
destinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[];
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
id_client: string;
id_organization: string;
keycloak_identifier?: string;
options: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
};
orchestrator_result?: Record<string, never>;
organization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
prompt: string;
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[];
source?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
};
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
}_id: string
accounts: string[]
Optionalarchived_date?: stringFormat: date-time
Description
When the plan was archived. Absent means it is active, which is how every plan created before archiving existed comes back.
It is a field of its own and NOT a value of `state` on purpose: `state` is the generation lifecycle and archiving is orthogonal to it — a `validated` plan that already published gets archived just like a `failed` one. Inside the enum you would have to decide which state it returns to when unarchived, and that question has no answer. Archiving is visibility only: it takes the plan out of the default listing and touches no publication. Anything it had scheduled keeps publishing.attempts: number
creation_date: string
Format: date-time
credits_spent: number
Optionaldestinations?: {
destination: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
id_account: string;
}[]Optionalerror?: { code: number; data?: { [key: string]: unknown }; message: string }Optionalgeneration_end_date?: stringFormat: date-time
id_client: string
id_organization: string
Optionalkeycloak_identifier?: stringoptions: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
}allow_images: boolean
gallery_uploads: string[]
language: string
Optionallink?: stringOptionalmax_images?: numberpublish_days: number[]
Description
Days of the week the plan publishes on, in ISO 8601 numbering (1 = Monday ... 7 = Sunday). Defaults to the whole week. There is still at most ONE publication per day and account, so this is what bounds the size and the cost of the plan: the number of generated posts is (selected days x accounts). Must be a non-empty array of unique integers between 1 and 7, or the request is rejected with 2106. The 7-day window starts at week_start, so each ISO day appears exactly once: with a week_start in mid-week, day 1 (Monday) is the FOLLOWING Monday. If the selected days leave no future slot at all, the request is rejected with 2108.
shared: boolean
timezone: string
Optionaltone?: stringuse_organization_context: boolean
week_start: string
Format: date-time
Optionalorchestrator_result?: Record<string, never>Optionalorganization_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
}Optionalaudience?: stringOptionalavoid?: stringOptionalblog_url?: stringOptionalbrand_name?: stringOptionaldefault_tone?: stringOptionaldescription?: stringOptionalkeywords?: string[]Optionalnotes?: stringOptionalproducts?: stringOptionalsector?: stringOptionalshop_url?: stringOptionalsocial_urls?: string[]Optionalvalue_proposition?: stringOptionalwebsite?: string
prompt: string
publications: (
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}
)[]Optionalsource?: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
}Optionalevent?: { date?: string; name?: string }Optionaldate?: stringFormat: date-time
Optionalname?: string
Optionalid_account_catalog?: stringOptionalid_integration_catalog?: stringOptionalimages?: { description?: string; id_upload?: string }[]Optionalproducts?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[]Optionaltext?: stringOptionalurl?: string
state: "pending" | "generating" | "generated" | "validated" | "failed" | "cancelled"
Optionaltemplate?: "standard" | "from_images" | "from_text" | "from_catalog" | "campaign"Optionalwarnings?: { code: number; data?: { [key: string]: unknown }; message: string }[]Description
Non-blocking notices about the LAST attempt (they are cleared when a new one starts). The plan is generated and perfectly usable; your UI just has to say what happened.
Today there are two. **2117 — some source items did not fit in the plan week.** A plan is weekly and the source does not extend it, so 12 photos with 6 slots left publish 6 and the rest are dropped. `data` carries `{ source_items, capacity }`. Better said BEFORE creating the plan (the slots are the publish days x the accounts) than after charging for it. **922 — a publication of a network that cannot publish without an image was left without one.** On Pinterest a pin is an image or a video, never text. The plan cannot be created with a configuration that would cause this (2119), but an image generation that fails halfway through the plan cannot be foreseen. `data` carries `{ step, social_network, id_account, id_publication }`: that draft will not publish until it has an image — regenerate it or attach one.
AiPlansAiPlanOptions: {
allow_images: boolean;
gallery_uploads: string[];
language: string;
link?: string;
max_images?: number;
publish_days: number[];
shared: boolean;
timezone: string;
tone?: string;
use_organization_context: boolean;
week_start: string;
}allow_images: boolean
gallery_uploads: string[]
language: string
Optionallink?: stringOptionalmax_images?: numberpublish_days: number[]
Description
Days of the week the plan publishes on, in ISO 8601 numbering (1 = Monday ... 7 = Sunday). Defaults to the whole week. There is still at most ONE publication per day and account, so this is what bounds the size and the cost of the plan: the number of generated posts is (selected days x accounts). Must be a non-empty array of unique integers between 1 and 7, or the request is rejected with 2106. The 7-day window starts at week_start, so each ISO day appears exactly once: with a week_start in mid-week, day 1 (Monday) is the FOLLOWING Monday. If the selected days leave no future slot at all, the request is rejected with 2108.
shared: boolean
timezone: string
Optionaltone?: stringuse_organization_context: boolean
week_start: string
Format: date-time
AiPlansAiPlanOptionsInput: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
link?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
}Optionalallow_images?: booleanOptionalgallery_uploads?: string[]Description
Upload ids from the organization's gallery used as visual reference for the generated images. They are references for the images the model GENERATES, so a template that does not generate them does not accept them either (
allows_gallery): sending them tofrom_imagesorfrom_catalogis a 2106.Optionallanguage?: stringOptionallink?: stringDescription
The destination link of the plan's publications — the pin's
link, the same for every publication of the plan. Optional: a pin without a link is legitimate, it just takes nobody anywhere. Onfrom_catalog, each pin leads to its product's page (permalink) when this is absent; when it is present, it wins.It only reaches the publications of the networks that answer `link: true` in `GET /social_capabilities` (today `pinterest`); with none of them in the plan it is dropped. With one, it is validated **at creation**: a URL Pinterest would reject is a **994** now (`data.reason` `invalid_url` or `too_long`), not a week of pins failing at publish time.Optionalmax_images?: numberOptionalpublish_days?: number[]Description
Days of the week the plan publishes on, in ISO 8601 numbering (1 = Monday ... 7 = Sunday). Defaults to the whole week. There is still at most ONE publication per day and account, so this is what bounds the size and the cost of the plan: the number of generated posts is (selected days x accounts). Must be a non-empty array of unique integers between 1 and 7, or the request is rejected with 2106. The 7-day window starts at week_start, so each ISO day appears exactly once: with a week_start in mid-week, day 1 (Monday) is the FOLLOWING Monday. If the selected days leave no future slot at all, the request is rejected with 2108. Optional; defaults to
[1,2,3,4,5,6,7].Optionalshared?: booleanDescription
Generate ONE piece of content per day and replicate it across every account, each scheduled at the best hour for ITS network, instead of one publication per account and day. Cheaper — one text and one image per day — and it caps images at 7. Optional; defaults to
false. Not every template accepts it (allows_sharedinGET /planner_templates):from_imagesandfrom_catalogdo not, because each of their publications carries a photo of its own, and sendingtrueto them is rejected with 2106.Optionaltimezone?: stringOptionaltone?: stringOptionaluse_organization_context?: booleanOptionalweek_start?: stringFormat: date-time
AiPlansAiPlanResults: {
ai_plans: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[];
by_template: (
{
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
} & {
template: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
}
)[];
range: {
from_date: string;
previous_from_date?: string;
previous_to_date?: string;
to_date: string;
};
sort: string;
total: number;
totals: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
};
}ai_plans: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[]by_template: (
{
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
} & {
template: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
}
)[]range: {
from_date: string;
previous_from_date?: string;
previous_to_date?: string;
to_date: string;
}from_date: string
Format: date-time
Optionalprevious_from_date?: stringFormat: date-time
Optionalprevious_to_date?: stringFormat: date-time
to_date: string
Format: date-time
sort: string
total: number
totals: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
}Optionalcredits_per_engagement?: numbercredits_spent: number
Optionalengagement_per_publication?: numberOptionalengagement_vs_average?: numberOptionalexpected_engagement_per_publication?: numbermetrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
plans: number
publications: { measured: number; published: number }
ranked_plans: number
AiPlansAiPlanResultsTemplateGroup: {
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
plans: number;
publications: { measured: number; published: number };
ranked_plans: number;
} & {
template: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
}AiPlansAiPlanSource: {
event?: { date?: string; name?: string };
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description?: string; id_upload?: string }[];
products?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[];
text?: string;
url?: string;
}Optionalevent?: { date?: string; name?: string }Optionaldate?: stringFormat: date-time
Optionalname?: string
Optionalid_account_catalog?: stringOptionalid_integration_catalog?: stringOptionalimages?: { description?: string; id_upload?: string }[]Optionalproducts?: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}[]Optionaltext?: stringOptionalurl?: string
AiPlansAiPlanSourceImageInput: { description: string; id_upload: string }
description: string
id_upload: string
AiPlansAiPlanSourceInput: {
event_date?: string;
event_name?: string;
id_account_catalog?: string;
id_integration_catalog?: string;
images?: { description: string; id_upload: string }[];
product_catalog_id?: string;
products?: string[];
text?: string;
url?: string;
}Description
The plan's source, as you SEND it. One shape per template: send only the fields of the template you chose — what it does not read is ignored, and what it needs and does not get is a 2112.
It is validated when the plan is **created**, not when it is generated: the article is downloaded, the catalogue or the store is read live and the product pictures are copied. So a source that does not work fails while the user is still there and can fix it, and what gets stored is a SNAPSHOT — a retry three days later does not depend on the article still being online or the product still being in the catalogue. | Template | Fields | | --- | --- | | `standard` | none — no source | | `from_images` | `images` | | `from_text` | `url` **or** `text` | | `from_catalog` | `id_account_catalog` + `product_catalog_id` (a Meta catalogue) **or** `id_integration_catalog` (a connected store), and `products` | | `campaign` | `event_name`, `event_date` |Optionalevent_date?: stringFormat: date
Description
campaign. The day of the event. Send a calendar day,YYYY-MM-DD— never an ISO instant. A bare date is read in the plan'soptions.timezone, which is the whole point:2026-09-15T00:00:00Zis midnight UTC, that is the 14th in the afternoon in New York — a whole day off in a countdown, for half of America, with no error anywhere. It cannot fall before the plan week (options.week_start) nor more than 60 days after it (2112). And it does not movepublish_days: if the event lands on a day you did not choose, the plan respects your choice and it is up to you to say so.Optionalevent_name?: stringOptionalid_account_catalog?: stringDescription
from_catalog, from a Meta catalogue. Which account's catalogue the products come from. It has to belong to the organization (2103) and be on a network that supports products (2115). It only chooses the catalogue: the publications still go to every account inaccounts— a LinkedIn account can publish a product from a Facebook catalogue. Exclusive withid_integration_catalog(both at once is a 2112).Optionalid_integration_catalog?: stringDescription
from_catalog, from a connected store. An integration of the organization whose provider hascatalog: true(a WooCommerce store), enabled; another organization's is a 2200, without confirming it exists. The products are itsexternal_ids, fromGET .../integrations/{id_integration}/products. Like the account, it only chooses the catalogue: the publications go to every account inaccounts. Exclusive withid_account_catalog.Optionalimages?: { description: string; id_upload: string }[]Description
from_images. Your own photos, each with its own description, in the order that tells the story: the orchestrator picks one per publication and keeps its position insource_index, so photo 3 can be the "before" and photo 7 the "after". Up to 20 (max_source_items), and each one has to be an image upload of this organization (806 otherwise).Optionalproduct_catalog_id?: stringOptionalproducts?: string[]Description
from_catalog. Ids of the chosen products, in the order they should tell the week. Up to 12 — a unit here is not an id already in the database: it is a live read plus a real download inside this request, with the user waiting. Repeated ids are deduplicated. They are ALL checked against the catalogue before a single picture is downloaded (2112 naming the missing one, or the one that is out of stock), and each picture is copied into an upload of the organization: a catalogue's picture URL expires or changes, and a plan published weeks later would carry a broken file. Those uploads count against the storage quota.Optionaltext?: stringDescription
from_text. The article pasted by hand. It wins overurlwhen both come: pasting is what a user does when the download did not work (a paywall, a page that needs JavaScript), so re-downloading to ignore what they wrote would take away their only way out. Truncated to 12.000 characters — the cap is what keeps the estimate honest, since the real charge is per use. Under 200 characters it is not an article, it is the theme, which ispromptand another field (2116).Optionalurl?: stringFormat: uri
Description
from_text. The article the plan is written from. It is downloaded at creation, and onlyhttp/httpsaddresses that resolve to a public IP are accepted — checked again before every redirect (2114). A page that answers something that is not text or HTML, or that carries no usable text once stripped, is a 2113: paste the text intextinstead.
AiPlansAiPlanSourceProduct: {
description?: string;
external_id?: string;
id_upload?: string;
name?: string;
permalink?: string;
price?: string;
}Optionaldescription?: stringOptionalexternal_id?: stringOptionalid_upload?: stringOptionalname?: stringOptionalpermalink?: stringDescription
The product's public page (a store's product page, or the
urlof the Meta catalogue item), kept only when it is an http(s) address. The texts use it on the networks where a link in the text can be clicked, never on Instagram or TikTok; and a Pinterest pin leads there unless the plan has its ownoptions.link. Absent on plans created before the field existed.Optionalprice?: stringDescription
The price exactly as the source gave it: Meta's formatted price ("9,99 €"), or a store's displayed price with its tax, symbol and range ("14,52 € IVA incluido"). It is never converted: the same field is a number in other paths of Meta's API and there is no way to tell units from cents, and dividing by 100 "just in case" is precisely how a 10 € product gets advertised at 0,10 €. The prompt is told to copy it verbatim or to say nothing. Absent when the product has no price, and on a store's taxable products while its
config.tax_location_missingis true.
AppsClientApp: {
_id: string;
allowed_domains: string[];
creation_date: string;
deleted: boolean;
deleted_date?: string;
id_client: string;
id_user?: string;
keycloak_client_idenfifier: string;
name: string;
redirect_urls: string[];
webhook_url?: string;
}_id: string
allowed_domains: string[]
creation_date: string
Format: date-time
deleted: boolean
Optionaldeleted_date?: stringFormat: date-time
id_client: string
Optionalid_user?: stringkeycloak_client_idenfifier: string
name: string
redirect_urls: string[]
Optionalwebhook_url?: stringDescription
Where PlanVortex posts events, when one is configured.
**The body is an array of changes, not a single object**, and it carries two signature headers computed with this app's secret over the **raw** body: `x-hub-signature` (`sha1=<hex>`) and `x-hub-signature-256` (`sha256=<hex>`). Verify against the bytes you received — parsing the JSON and re-serialising it changes them and the signature will not match. The events delivered today are `new_account`, `change_state_account`, `messages`, `messaging_postbacks`, `messaging_seen`, `messaging_error`, `comments`, `integration_error`, `ai_plan_generated` and `ai_plan_failed`. The payload is documented in the `comments` specification. **Every** app of the client that has a `webhook_url` receives every event, not only the app whose call caused it: with two apps, each event arrives twice. Delivery is best effort: PlanVortex does not retry a webhook that fails.
AppsClientAppInput: {
allowed_domains?: string[];
keycloak_client_idenfifier: string;
name: string;
redirect_urls?: string[];
webhook_url?: string;
}Optionalallowed_domains?: string[]keycloak_client_idenfifier: string
Description
The app's
client_id, which is what you send toPOST /oauth/token.**Format is enforced** (error 533): lowercase letters, numbers, `.`, `-` and `_`, starting with a letter or a number, between 3 and 64 characters — `shop-integration`, not `Shop Integration`. Keycloak itself accepts anything, so an identifier with a space in it used to create an app that could never get a token. It also has to be unique across PlanVortex (error 534), and **it cannot be changed once the app exists** (error 547): it is what your integration authenticates with, so renaming it would lock out everything already using the old one. Send it unchanged on an update, or leave it out. The spelling of the field is historical and kept for compatibility.name: string
Optionalredirect_urls?: string[]Optionalwebhook_url?: string
AppsOAuthError: {
error:
| "server_error"
| "invalid_client"
| "slow_down"
| "invalid_request"
| "unsupported_grant_type";
error_description?: string;
}AppsTokenRequest: {
client_id?: string;
client_secret?: string;
grant_type: "client_credentials";
scope?: string;
}Optionalclient_id?: stringOptionalclient_secret?: stringgrant_type: "client_credentials"
Optionalscope?: string
AppsTokenResponse: { access_token: string; expires_in: number; scope?: string; token_type: string }
access_token: string
expires_in: number
Optionalscope?: stringtoken_type: string
CatalogAspectRatios: { text: string[]; values: number[] }
text: string[]
values: number[]
CatalogPlannerTemplate: {
allows_gallery?: boolean;
allows_shared?: boolean;
generates_images?: boolean;
max_source_items?: number;
orchestration_cost?: number;
orchestration_cost_per_source_item?: number;
regenerate?: { image?: boolean; text?: boolean };
source_fields?: {
default?: unknown;
max?: number;
min?: number;
name?: string;
options?: string[];
required?: boolean;
type?:
| "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "date"
| "uploads_with_description"
| "catalog_products";
}[];
source_requires_any?: string[];
template?: | "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
unsupported_networks?: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
}Optionalallows_gallery?: booleanOptionalallows_shared?: booleanOptionalgenerates_images?: booleanOptionalmax_source_items?: numberOptionalorchestration_cost?: numberOptionalorchestration_cost_per_source_item?: numberOptionalregenerate?: { image?: boolean; text?: boolean }Optionalsource_fields?: {
default?: unknown;
max?: number;
min?: number;
name?: string;
options?: string[];
required?: boolean;
type?:
| "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "date"
| "uploads_with_description"
| "catalog_products";
}[]Optionalsource_requires_any?: string[]Description
Fields of which AT LEAST ONE is needed, even though none of them is required on its own:
from_texttakes the URL or the pasted text, never both empty (2116);from_catalogtakesid_account_catalogorid_integration_catalog, and exactly one (2112 with both).It exists because a field's `required` cannot say "one or the other", and without it your UI would have to hardcode that rule — exactly the copy this catalogue exists to avoid. Absent = there is nothing of the sort to resolve.Optionaltemplate?: "standard" | "from_images" | "from_text" | "from_catalog" | "campaign"Description
What the plan is generated FROM, and what you send as
templatewhen creating it:• **`standard`** — a theme prompt, images generated by the model. What every plan was before templates existed. • **`from_images`** — the user's own photos, each with its own description. One vision pass over ALL of them at once, so the model can sequence a narrative (photo 3 the "before", photo 7 the "after") instead of writing seven independent posts. It generates no images. • **`from_text`** — an article: a URL that is downloaded at creation, or the text pasted by hand. • **`from_catalog`** — products read LIVE from a connected catalogue (a Meta catalogue through a connected account, or a connected store such as WooCommerce), with their name, their description, their price, their picture and the link to their page. The one template that cannot be copied by a generic AI tool, because it needs the catalogue connection. • **`campaign`** — a countdown towards a date, with a narrative arc: teaser, announcement, reminder, today, thank you. The only plan that is a story instead of seven loose posts.Optionalunsupported_networks?: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[]Description
Networks whose accounts cannot be in a plan of this template: creating one is refused with 2120, before anything is read or charged. The ones that do not publish (
whatsapp,google_business) on every template; and on the templates where every publication is the photo of its source (from_images,from_catalog), also the ones that do not publish images:youtube, which only uploads video.It is computed from the same data that validates publishing, not from a list: a new network that does not publish photos drops out on its own. Filter the accounts you offer with it.
CatalogPlannerTemplateField: {
default?: unknown;
max?: number;
min?: number;
name?: string;
options?: string[];
required?: boolean;
type?:
| "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "date"
| "uploads_with_description"
| "catalog_products";
}Optionaldefault?: unknownOptionalmax?: numberOptionalmin?: numberDescription
Floor in the field's own units. Today only
from_text: under 200 characters it is not an article, it is the theme, which ispromptand another field. Published for the same reason asmax— without it your UI hardcodes the 200 and the user gets a 2116 AFTER pasting the text instead of while pasting it.Optionalname?: stringOptionaloptions?: string[]Optionalrequired?: booleanOptionaltype?:
| "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "date"
| "uploads_with_description"
| "catalog_products"
CatalogSocialLimits: {
characters: { [key: string]: number };
comment_characters: { [key: string]: number };
max_file_size_mb: { [key: string]: number };
max_post_bytes: { [key: string]: number };
title_characters: { [key: string]: number };
total_images: { [key: string]: number };
video_duration_in_seconds: { [key: string]: number };
}characters: { [key: string]: number }
Description
Maximum length of a publication's text. Bluesky and Threads count GRAPHEMES, everyone else counts characters — Telegram included, where
String.lengthis exactly the right unit. The difference is not academic: an emoji is one grapheme and twoString.lengthunits, so counting a Threads post with.lengthrejects at 250 emojis what the network publishes happily at 500.On Telegram there are **two numbers for the same field**: `telegram` (4.096) while the publication is text only, and `telegram_media` (1.024) the moment it carries an image or a video, because then the text is a media caption and not a message. Switch the counter when the file is attached, not when publish is pressed.comment_characters: { [key: string]: number }
max_file_size_mb: { [key: string]: number }
Description
Maximum size of one file, in megabytes.
**On `slack` this one is a ceiling, not a promise.** 1.024 MB is what the network allows; the real limit is the lesser of that and the storage the client's own workspace plan still has, which no API exposes. A file inside this number can still come back as error 986. It is the only key in this map with that property. **On `pinterest` this number is the IMAGE one** (~20 MB); a video is allowed two orders of magnitude more. It is the one entry in this map that does not apply to every file of its network, so a size warning shown against it would be wrong on every video. Over whichever ceiling applies, the publication is created in state `withErrors` with `publication_errors[].code = 996` and `data.max_mb`.max_post_bytes: { [key: string]: number }
title_characters: { [key: string]: number }
total_images: { [key: string]: number }
Description
How many images one publication accepts.
0means images are not a publication on that network.**On `discord`, `threads` and `slack` it counts images and videos together**, because there the carousel is one message carrying several attachments and not several publications: what is validated is the total number of files. Over it, the publication is created in state `withErrors` — on `slack` with `publication_errors[].code = 982`. **On `pinterest` it is a ceiling with a floor under it.** Several images are a carousel of 2 to 5: one image is not a small carousel (it is a plain image pin, which is a different call) and six is not a trimmed one. Outside that range the publication is created in state `withErrors` with `publication_errors[].code = 990`.video_duration_in_seconds: { [key: string]: number }
CatalogSocialLimitsMap: { [key: string]: number }
Description
One number per network. Every network in
/social_networksis present.**And a few keys are not a network.** Some limits depend on the *kind* of publication rather than on the network alone, and those get a compound key next to the plain one: `instagram_story`, `facebook_reel`, `telegram_media`. Read the plain key by default and the compound one when it applies.ClientsAiScopeSetting: {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter" | "openai" | "google" | "anthropic";
}Optionalapi_key?: stringOptionalReadonlyhas_api_key?: booleanmodel: string
provider: "openrouter" | "openai" | "google" | "anthropic"
ClientsAiSettings: {
image?:
| null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
}Description
Per-scope AI provider configuration (BYOK). Only the scopes you send are touched; a scope set to
nullclears its configuration and returns that scope to PlanVortex credits.orchestratorandtextneed a text-capable provider,imageneeds an image-capable one.videois reserved for a later phase.Optionalimage?:
| null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
}Optionalorchestrator?:
| null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
}Optionaltext?:
| null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
}
ClientsClient: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
}_id: string
Optionalactual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
}Optionalcurrent_period_end?: stringFormat: date-time
Optionalcurrent_period_start?: stringFormat: date-time
enabled: boolean
isEnabled: boolean
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
plan_identifier: "basic" | "free" | "pro" | "custom"
Optionalrequire_action?: booleanstatus: string
Optionalstripe_customer_id?: string
Optionalactual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}Optionalai_settings?: {
image?:
| null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
}Optionalimage?:
| null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
}Optionalorchestrator?:
| null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
}Optionaltext?:
| null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
}
Optionalclient_type?: "personal" | "company"creation_date: string
Format: date-time
name: string
Optionaltrial_tested?: boolean
ClientsClientList: {
clients: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
}[];
total: number;
}ClientsClientOne: {
client: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
};
}client: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_settings?: {
image?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
};
client_type?: "personal"
| "company";
creation_date: string;
name: string;
trial_tested?: boolean;
}_id: string
Optionalactual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
}Optionalcurrent_period_end?: stringFormat: date-time
Optionalcurrent_period_start?: stringFormat: date-time
enabled: boolean
isEnabled: boolean
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
plan_identifier: "basic" | "free" | "pro" | "custom"
Optionalrequire_action?: booleanstatus: string
Optionalstripe_customer_id?: string
Optionalactual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}Optionalai_settings?: {
image?:
| null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
orchestrator?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
text?: | null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
};
}Optionalimage?:
| null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
}Optionalorchestrator?:
| null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
}Optionaltext?:
| null
| {
api_key?: string;
has_api_key?: boolean;
model: string;
provider: "openrouter"
| "openai"
| "google"
| "anthropic";
}
Optionalclient_type?: "personal" | "company"creation_date: string
Format: date-time
name: string
Optionaltrial_tested?: boolean
ClientsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
name: string;
}Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
name: string
ClientsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}[];
total: number;
}ClientsOrganizationOne: {
organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
}organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}_id: string
Optionalactual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}Description
The slice of the client's plan assigned to this organization. Absent when nothing was assigned, and then the organization shares whatever its nearest parent with a plan has — or, failing that, the client's unassigned remainder. Ask
GET /organizations/{id_organization}/limitsfor the effective numbers instead of reading this.accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
Optionalactual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}Optionalai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
}Optionalaudience?: stringOptionalavoid?: stringOptionalblog_url?: stringOptionalbrand_name?: stringOptionaldefault_tone?: stringOptionaldescription?: stringOptionalkeywords?: string[]Optionalnotes?: stringOptionalproducts?: stringOptionalsector?: stringOptionalshop_url?: stringOptionalsocial_urls?: string[]Optionalvalue_proposition?: stringOptionalwebsite?: string
creation_date: string
Format: date-time
id_client: string
name: string
Optionalparent_organization?: stringOptionalsocial_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
}Optionaldiscord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
}Optionalapplication_name?: stringOptionalclient_id?: stringOptionalhas_bot_token?: booleanOptionalhas_client_secret?: booleanOptionalverified_date?: stringFormat: date-time
Optionalstats_settings?: { auto_refresh_twitter: boolean }auto_refresh_twitter: boolean
ClientsOrganizationUpdate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
stats_settings?: { auto_refresh_twitter: boolean };
}Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
Optionalstats_settings?: { auto_refresh_twitter: boolean }auto_refresh_twitter: boolean
ClientsPlan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
}Optionalcurrent_period_end?: stringFormat: date-time
Optionalcurrent_period_start?: stringFormat: date-time
enabled: boolean
isEnabled: boolean
plan_data: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
plan_identifier: "basic" | "free" | "pro" | "custom"
Optionalrequire_action?: booleanstatus: string
Optionalstripe_customer_id?: string
ClientsRolesClientPermissions:
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"ClientsRolesClientPermissionsList: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[]ClientsRolesClientPermissionsOne: {
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
}ClientsRolesRole: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
}ClientsRolesRoleInput: {
name: string;
permissions: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
| "client_organization_products:create"
| "client_organization_products:update"
| "client_organization_products:read"
| "client_organization_products:delete"
| "client_organization_messages:create"
| "client_organization_messages:read"
| "client_organization_messages:delete"
| "client_organization_contacts:create"
| "client_organization_contacts:read"
| "client_organization_contacts:update"
| "client_organization_contacts:delete"
| "client_organization_ai_plans:create"
| "client_organization_ai_plans:read"
| "client_organization_ai_plans:update"
| "client_organization_ai_plans:delete"
)[];
}name: string
permissions: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
| "client_organization_products:create"
| "client_organization_products:update"
| "client_organization_products:read"
| "client_organization_products:delete"
| "client_organization_messages:create"
| "client_organization_messages:read"
| "client_organization_messages:delete"
| "client_organization_contacts:create"
| "client_organization_contacts:read"
| "client_organization_contacts:update"
| "client_organization_contacts:delete"
| "client_organization_ai_plans:create"
| "client_organization_ai_plans:read"
| "client_organization_ai_plans:update"
| "client_organization_ai_plans:delete"
)[]
ClientsRolesRoleList: {
roles?: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
}[];
total?: number;
}ClientsRolesRoleOne: {
rol?: {
name?: string;
permissions?: (
| "client:update"
| "client:read"
| "client:delete"
| "client_app:create"
| "client_app:update"
| "client_app:read"
| "client_app:delete"
| "client_roles:create"
| "client_roles:update"
| "client_roles:read"
| "client_roles:delete"
| "client_roles_users:read"
| "client_roles_users:create"
| "client_roles_users:delete"
| "client_organization:create"
| "client_organization:update"
| "client_organization:read"
| "client_organization:delete"
| "client_organization_roles:read"
| "client_organization_roles:create"
| "client_organization_roles:update"
| "client_organization_roles:delete"
| "client_organization_users_roles:read"
| "client_organization_users_roles:create"
| "client_organization_users_roles:delete"
| "client_organization_accounts:read"
| "client_organization_accounts:create"
| "client_organization_accounts:update"
| "client_organization_accounts:delete"
| "client_organization_files:read"
| "client_organization_files:create"
| "client_organization_files:update"
| "client_organization_files:delete"
| "client_organization_publications:read"
| "client_organization_publications:create"
| "client_organization_publications:update"
| "client_organization_publications:delete"
| "client_organization_publications_stats:read"
| "client_organization_account_stats:read"
)[];
};
}ClientsRolesUser: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
}ClientsRolesUserList: {
total?: number;
users?: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
}[];
}CommentsAiPlanWebhookChange: {
credits_spent: number;
error?: { code: number; message: string };
field: "ai_plan_generated" | "ai_plan_failed";
id_ai_plan: string;
id_organization: string;
state: "generated" | "failed";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
total_publications: number;
warnings: number;
}Description
One change in the array PlanVortex posts to your app's
webhook_url, when an AI plan finished:ai_plan_generatedwhen it came out,ai_plan_failedwhen it gave up.Like `IntegrationWebhookChange`, it carries no `id_account` and no `social_network`: a plan can span several networks, and it hangs off the organization. It carries ids and numbers only. Read the plan itself with `GET /clients/{id_client}/organizations/{id_organization}/ai_plans/{id_ai_plan}`.credits_spent: number
Optionalerror?: { code: number; message: string }field: "ai_plan_generated" | "ai_plan_failed"
id_ai_plan: string
id_organization: string
state: "generated" | "failed"
template: "standard" | "from_images" | "from_text" | "from_catalog" | "campaign"
total_publications: number
warnings: number
CommentsAiPlanWebhookError: { code: number; message: string }
CommentsComment: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
}_id: string
author: { external_id: string; is_own: boolean; name?: string; profile_pic?: string }
external_id: string
is_own: boolean
Optionalname?: stringOptionalprofile_pic?: string
collected_date: string
Format: date-time
creation_date: string
Format: date-time
deleted: boolean
external_id: string
Description
The comment's id on the network. Unique per account, and what makes repeated webhook deliveries idempotent.
Two exceptions worth knowing, and both are composite ids you should treat as opaque: • A Google Business reply has no id of its own — it is a *field* of the review — so PlanVortex fabricates a stable one, `{reviewId}/reply`. • A Telegram comment lives in a **different chat** from the post it answers (the channel's linked discussion group), so it needs two ids at once and travels as `{thread}/{message}`: replying wants the first, deleting wants the second.hidden: boolean
id_account:
| string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}Description
The connected account it arrived on.
**It is not always the same shape.** The inbox listing (`GET /organizations/{id}/comments`) returns the whole account resolved; every other operation — the live threads, the reply, the update — returns its identifier as a string. Check before using it.id_organization: string
Optionalid_publication?:
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}Description
Your publication, when there is one — and there often is not: a video uploaded to the channel by hand, a post that predates PlanVortex, and every Google Business review have comments with no publication of ours behind them. What always identifies the target is
publication_external_id.Same asymmetry as `id_account`: the inbox listing resolves it into the whole publication, every other operation returns the identifier as a string.Optionallike_count?: numberOptionalour_reply_external_id?: stringOptionalparent_external_id?: stringpublication_external_id: string
Optionalrating?: numberread: boolean
replied: boolean
Optionalreply_count?: numbersocial_network:
| "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"text: string
CommentsCommentActions: { delete_others: boolean; delete_own: boolean; hide: boolean; reply: boolean }
delete_others: boolean
delete_own: boolean
hide: boolean
reply: boolean
CommentsCommentAuthor: { external_id: string; is_own: boolean; name?: string; profile_pic?: string }
external_id: string
is_own: boolean
Optionalname?: stringOptionalprofile_pic?: string
CommentsCommentNetworkName:
| "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"CommentsCommentThread: {
comments: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
}[];
credits_consumed: number;
next_cursor?: string;
total: number;
}comments: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
}[]credits_consumed: number
Optionalnext_cursor?: stringtotal: number
CommentsIntegrationWebhookChange: {
error_code: number;
field: "integration_error";
id_integration: string;
id_organization: string;
provider: string;
}Description
One change in the array PlanVortex posts to your app's
webhook_url, when an integration stopped working: a revoked Google Drive token, a feed that no longer answers, a publication quota that ran out.It carries neither `id_account` nor `social_network`, because an integration hangs off the organization and not off any account — which is exactly why it is a type of its own. A consumer that only understands account changes sees a `field` it does not know and ignores it, which is what should happen.error_code: number
field: "integration_error"
id_integration: string
id_organization: string
provider: string
CommentsSocialCapabilities: {
comments: boolean;
destinations: boolean;
link: boolean;
made_for_kids: boolean;
messages: boolean;
persistent_menu: boolean;
products: boolean;
publications: boolean;
reply_control: boolean;
visibility: boolean;
webhooks: boolean;
}comments: boolean
destinations: boolean
Description
The network publishes into places inside the account, and every publication has to name one: a Pinterest board. When this is
true, readGET /organizations/{id_organization}/accounts/{id_account}/destinationsand send one back indestination— a publication created without it lands in statewithErrorswithpublication_errors[].code = 987. Today onlypinterest.link: boolean
made_for_kids: boolean
messages: boolean
persistent_menu: boolean
products: boolean
publications: boolean
reply_control: boolean
Description
The publication can say who can reply to it (
reply_control): anyone, the account's followers, the profiles it follows or the profiles mentioned in the text. It is set when the publication goes out and cannot be changed afterwards. On a network that answersfalsethe field is deleted on save, so do not offer it. Today onlythreads.visibility: boolean
webhooks: boolean
CommentsWebhookChange: {
commentObj?: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
};
field: | "comments"
| "messages"
| "new_account"
| "change_state_account"
| "messaging_postbacks"
| "messaging_seen"
| "messaging_error";
id_account: string;
id_contact?: string;
id_organization: string;
messageObj?: {
_id: string;
contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
creation_date: string;
element_external_id?: string;
from_contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
id_account: string;
in_response_external_id?: string;
in_response_to?: string;
message_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...)
| (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
read: boolean;
text?: string;
};
originalChange?: { [key: string]: unknown };
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}Description
One change in the array PlanVortex posts to your app's
webhook_url, when the change concerns a social account.An integration that stopped working has a shape of its own (`IntegrationWebhookChange`), and so does an AI plan that finished (`AiPlanWebhookChange`). One delivery can mix them. Switch on `field`, and ignore what you do not handle.OptionalcommentObj?: {
_id: string;
author: {
external_id: string;
is_own: boolean;
name?: string;
profile_pic?: string;
};
collected_date: string;
creation_date: string;
deleted: boolean;
external_id: string;
hidden: boolean;
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
like_count?: number;
our_reply_external_id?: string;
parent_external_id?: string;
publication_external_id: string;
rating?: number;
read: boolean;
replied: boolean;
reply_count?: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads";
text: string;
}_id: string
author: { external_id: string; is_own: boolean; name?: string; profile_pic?: string }
external_id: string
is_own: boolean
Optionalname?: stringOptionalprofile_pic?: string
collected_date: string
Format: date-time
creation_date: string
Format: date-time
deleted: boolean
external_id: string
Description
The comment's id on the network. Unique per account, and what makes repeated webhook deliveries idempotent.
Two exceptions worth knowing, and both are composite ids you should treat as opaque: • A Google Business reply has no id of its own — it is a *field* of the review — so PlanVortex fabricates a stable one, `{reviewId}/reply`. • A Telegram comment lives in a **different chat** from the post it answers (the channel's linked discussion group), so it needs two ids at once and travels as `{thread}/{message}`: replying wants the first, deleting wants the second.hidden: boolean
id_account:
| string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}Description
The connected account it arrived on.
**It is not always the same shape.** The inbox listing (`GET /organizations/{id}/comments`) returns the whole account resolved; every other operation — the live threads, the reply, the update — returns its identifier as a string. Check before using it.id_organization: string
Optionalid_publication?:
| string
| {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...) | (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: ... } & { [key: ...]: ... };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}Description
Your publication, when there is one — and there often is not: a video uploaded to the channel by hand, a post that predates PlanVortex, and every Google Business review have comments with no publication of ours behind them. What always identifies the target is
publication_external_id.Same asymmetry as `id_account`: the inbox listing resolves it into the whole publication, every other operation returns the identifier as a string.Optionallike_count?: numberOptionalour_reply_external_id?: stringOptionalparent_external_id?: stringpublication_external_id: string
Optionalrating?: numberread: boolean
replied: boolean
Optionalreply_count?: numbersocial_network:
| "facebook"
| "instagram"
| "linkedin"
| "twitter"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"text: string
field:
| "comments"
| "messages"
| "new_account"
| "change_state_account"
| "messaging_postbacks"
| "messaging_seen"
| "messaging_error"Description
What kind of change this is. Treat it as an open list and ignore what you do not handle: it grows with the product.
- `new_account` / `change_state_account`: an account was connected, or its state changed — it stopped working, its token was refreshed, it was disconnected. On `telegram` this is the **only** way to hear about a connection: there is no callback there, so no request of yours ever returns that account. - `messages`: a message came in. It travels in `messageObj`. - `messaging_postbacks`: the contact pressed a button or a quick reply. Also in `messageObj`. - `messaging_seen`: the contact read the conversation. `messageObj` carries the message they read, when we still have it. - `messaging_error`: the network refused a message we sent. The reason is in `messageObj.message_errors`. - `comments`: a comment came in. It travels in `commentObj`, never in `messageObj`.id_account: string
Optionalid_contact?: stringid_organization: string
OptionalmessageObj?: {
_id: string;
contact_id?:
| string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
creation_date: string;
element_external_id?: string;
from_contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
id_account: string;
in_response_external_id?: string;
in_response_to?: string;
message_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...)
| (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
read: boolean;
text?: string;
}Description
The message. Present for the messaging fields, never for a comment — a comment is not a message and does not travel in here.
It arrives **populated**: `contact_id`, `from_contact_id` and `message_options.files` carry whole objects. On `messaging_seen` and `messaging_error` it can be absent, because the message being acknowledged may not be one of ours._id: string
Optionalcontact_id?:
| string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
}creation_date: string
Format: date-time
Optionalelement_external_id?: stringOptionalfrom_contact_id?:
| string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
}id_account: string
Optionalin_response_external_id?: stringOptionalin_response_to?: stringmessage_errors: { code: number; data?: { [key: string]: unknown }; message: string }[]
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...)
| (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
}files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: (...)
| (...);
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[]files_urls: { mime_type?: string; url?: string }[]
OptionalmetaElements?: { [key: string]: unknown }[]OptionalmetaQuickReplies?: { [key: string]: unknown }[]Optionalpayload?: stringOptionaltemplate_language?: stringOptionaltemplate_name?: stringOptionaltemplate_parameters?: string[]Description
For a
template_messagewhose body has variables: their values, in order. The first one fills{{1}}, the second{{2}}, and so on. Without them WhatsApp rejects a template that has variables, so a reminder with the customer's name and time needs this. Each value is a non-empty string with no line breaks, no tabs and no more than four consecutive spaces; anything else answers1511withdata.field=template_parametersanddata.indexpointing at the bad value. Only positional body variables are supported: named variables ({{name}}) and variables in the header or in a button URL are not sent yet.OptionalwhatsappInteractive?: { [key: string]: unknown }
message_type:
| "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message"read: boolean
Optionaltext?: string
OptionaloriginalChange?: { [key: string]: unknown }social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
Contact: {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string | number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
}_id: string
creation_date: string
Format: date-time
Optionalcreator_keycloak_identifier?: stringOptionalextra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string | number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
}Optionaladdress?: stringOptionalboolean_property?: booleanOptionalboolean_property2?: booleanOptionalbuilding?: string | numberOptionalcity?: stringOptionalcoords?: number[]Optionalcountry?: stringOptionalcountry_code?: stringOptionaldoor?: string | numberOptionalfloor?: string | numberOptionalnumber?: string | numberOptionalnumber_property?: numberOptionalnumber_property2?: numberOptionalplace_id?: stringOptionalstate?: stringOptionalstring_property?: stringOptionalstring_property2?: stringOptionalzip_code?: string | number
id_organization: string
last_contact_update: string
Format: date-time
Optionalname?: stringOptionalprofile_image?: stringsocial_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[]
ContactChannel:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email"ContactExtraData: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string | number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
}Optionaladdress?: stringOptionalboolean_property?: booleanOptionalboolean_property2?: booleanOptionalbuilding?: string | numberOptionalcity?: stringOptionalcoords?: number[]Optionalcountry?: stringOptionalcountry_code?: stringOptionaldoor?: string | numberOptionalfloor?: string | numberOptionalnumber?: string | numberOptionalnumber_property?: numberOptionalnumber_property2?: numberOptionalplace_id?: stringOptionalstate?: stringOptionalstring_property?: stringOptionalstring_property2?: stringOptionalzip_code?: string | number
ContactsContactCreate: {
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string | number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
name?: string;
profile_image?: string;
social_identifiers: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
}Description
A new contact. At least one identifier is mandatory (
ERROR_CODE_1601otherwise): a contact with no channel is a contact nobody can write to.Creating is idempotent on the FIRST identifier: if the organization already has a contact with that channel and that `external_identifier`, you get the existing one back untouched — `name`, `profile_image` and `extra_data` of the request are ignored. There is no "already exists" error.Optionalextra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string | number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
}Optionaladdress?: stringOptionalboolean_property?: booleanOptionalboolean_property2?: booleanOptionalbuilding?: string | numberOptionalcity?: stringOptionalcoords?: number[]Optionalcountry?: stringOptionalcountry_code?: stringOptionaldoor?: string | numberOptionalfloor?: string | numberOptionalnumber?: string | numberOptionalnumber_property?: numberOptionalnumber_property2?: numberOptionalplace_id?: stringOptionalstate?: stringOptionalstring_property?: stringOptionalstring_property2?: stringOptionalzip_code?: string | number
Optionalname?: stringOptionalprofile_image?: stringsocial_identifiers: {
_id?: string;
external_identifier?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[]
ContactsContactUpdate: {
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string | number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
name?: string;
profile_image?: string;
social_identifiers?: {
_id?: string;
external_identifier?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
}Description
Changes to a contact.
name,profile_imageandsocial_identifiersare left alone when you omit them.**`extra_data` is the exception and it is destructive**: it is written with whatever the body carries, so omitting it ERASES every custom field on the contact. Read the contact, change what you need and send the whole block back.Optionalextra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string | number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
}Optionaladdress?: stringOptionalboolean_property?: booleanOptionalboolean_property2?: booleanOptionalbuilding?: string | numberOptionalcity?: stringOptionalcoords?: number[]Optionalcountry?: stringOptionalcountry_code?: stringOptionaldoor?: string | numberOptionalfloor?: string | numberOptionalnumber?: string | numberOptionalnumber_property?: numberOptionalnumber_property2?: numberOptionalplace_id?: stringOptionalstate?: stringOptionalstring_property?: stringOptionalstring_property2?: stringOptionalzip_code?: string | number
Optionalname?: stringOptionalprofile_image?: stringOptionalsocial_identifiers?: {
_id?: string;
external_identifier?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[]
ContactsSocialIdentifierInput: {
_id?: string;
external_identifier?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}Optional_id?: stringOptionalexternal_identifier?: stringsocial_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email"
DashboardAccountWithError: {
_id: string;
error_code: number;
image?: string;
name: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}_id: string
error_code: number
Optionalimage?: stringname: string
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"Optionalusername?: string
DashboardDashboard: {
account_metrics?: {
by_day: {
group: null | string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[];
by_network: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[];
previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
ai_plan_results?: {
engagement_per_publication?: number;
engagement_vs_average?: number;
plans: number;
ranked_plans: number;
top: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[];
};
ai_plans?: {
by_state: { state?: string; total?: number }[];
credits_spent: number;
generated_publications: number;
last_plan?: {
_id: string;
creation_date: string;
credits_spent?: number;
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
prompt?: string;
publications?: string[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
pending_validation: number;
total: number;
};
available_blocks: {
account_metrics: boolean;
ai_plan_results: boolean;
ai_plans: boolean;
health: boolean;
messages: boolean;
plan_use: boolean;
publication_metrics: boolean;
publications: boolean;
};
health?: {
accounts_with_errors?: {
_id: string;
error_code: number;
image?: string;
name: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}[];
publications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[];
total_drafts?: number;
upcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[];
};
messages?: { unread: number };
plan_use?: {
actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
};
publication_metrics?: {
by_network: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
top: {
collected_date?: string;
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: (...)
| (...);
cover_image?: (...) | (...);
cover_offset?: (...) | (...);
creation_date: string;
file_externals: (...)[];
file_format: (...) | (...) | (...) | (...) | (...);
file_properties: {
allowed_social_networks: ...;
aspect_ratio: ...;
duration: ...;
height: ...;
size_in_bytes: ...;
width: ...;
};
file_type: (...)
| (...);
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
};
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
publications?: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
by_state: { state?: string; total?: number }[];
published_by_day: {
day?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
total: number;
} & { previous_total?: number };
range: {
from_date: string;
previous_from_date: string;
previous_to_date: string;
to_date: string;
};
}Description
Everything the home screen needs, in ONE round trip.
**A missing block is not an error.** Each one is checked against its own permission and omitted when the caller cannot read it, instead of failing the whole request; `available_blocks` says which ones were allowed. A block that is `true` in `available_blocks` and absent from the body means there was no data — except `messages`, which also turns to `false` when the plan does not include chat.Optionalaccount_metrics?: {
by_day: {
group: null | string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[];
by_network: {
group: null
| string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[];
previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
}by_day: {
group: null | string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[]by_network: {
group: null | string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}[]previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
Optionalai_plan_results?: {
engagement_per_publication?: number;
engagement_vs_average?: number;
plans: number;
ranked_plans: number;
top: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[];
}Description
The best AI plans of the range, by interactions per measured publication — the short version of
GET /clients/{id}/organizations/{id}/ai_plans/results, with the same rules: the range filters on the plan's week, and only plans with at least 3 measured publications compete.Unlike that endpoint it covers the organization **and its children**, like the rest of this screen, so each plan carries its `id_organization`.Optionalengagement_per_publication?: numberOptionalengagement_vs_average?: numberplans: number
ranked_plans: number
top: {
accounts: number;
archived_date?: string;
creation_date: string;
credits_per_engagement?: number;
credits_spent: number;
engagement_per_publication?: number;
engagement_vs_average?: number;
expected_engagement_per_publication?: number;
id_ai_plan: string;
id_organization: string;
last_publish_date?: string;
maturing: boolean;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
prompt: string;
publications: {
failed: number;
measured: number;
published: number;
scheduled: number;
total: number;
};
ranked: boolean;
social_networks: (
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
)[];
state: "generated"
| "validated";
template:
| "standard"
| "from_images"
| "from_text"
| "from_catalog"
| "campaign";
week_start: string;
}[]
Optionalai_plans?: {
by_state: { state?: string; total?: number }[];
credits_spent: number;
generated_publications: number;
last_plan?: {
_id: string;
creation_date: string;
credits_spent?: number;
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
prompt?: string;
publications?: string[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
pending_validation: number;
total: number;
}by_state: { state?: string; total?: number }[]
credits_spent: number
generated_publications: number
Optionallast_plan?: {
_id: string;
creation_date: string;
credits_spent?: number;
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
prompt?: string;
publications?: string[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
}_id: string
creation_date: string
Format: date-time
Optionalcredits_spent?: numberOptionalerror?: { code: number; data?: { [key: string]: unknown }; message: string }Optionalgeneration_end_date?: stringFormat: date-time
Optionalprompt?: stringOptionalpublications?: string[]state: "pending" | "generating" | "generated" | "validated" | "failed" | "cancelled"
pending_validation: number
total: number
available_blocks: {
account_metrics: boolean;
ai_plan_results: boolean;
ai_plans: boolean;
health: boolean;
messages: boolean;
plan_use: boolean;
publication_metrics: boolean;
publications: boolean;
}account_metrics: boolean
ai_plan_results: boolean
ai_plans: boolean
health: boolean
messages: boolean
plan_use: boolean
publication_metrics: boolean
publications: boolean
Optionalhealth?: {
accounts_with_errors?: {
_id: string;
error_code: number;
image?: string;
name: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}[];
publications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[];
total_drafts?: number;
upcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[];
}Optionalaccounts_with_errors?: {
_id: string;
error_code: number;
image?: string;
name: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}[]Optionalpublications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...) | (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[]Optionaltotal_drafts?: numberOptionalupcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...) | (...);
message: string;
}[];
publication_warnings?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}[]
Optionalmessages?: { unread: number }Optionalplan_use?: {
actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
}actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
Optionalpublication_metrics?: {
by_network: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
top: {
collected_date?: string;
engagement_base?: "reach"
| "impressions"
| "followers";
id_publication: string;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: (...)
| (...);
cover_image?: (...) | (...);
cover_offset?: (...) | (...);
creation_date: string;
file_externals: (...)[];
file_format: (...) | (...) | (...) | (...) | (...);
file_properties: {
allowed_social_networks: ...;
aspect_ratio: ...;
duration: ...;
height: ...;
size_in_bytes: ...;
width: ...;
};
file_type: (...)
| (...);
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
};
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
}by_network: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[]previous_total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
top: {
collected_date?: string;
engagement_base?: "reach" | "impressions" | "followers";
id_publication: string;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: (...)
| (...);
cover_image?: (...) | (...);
cover_offset?: (...) | (...);
creation_date: string;
file_externals: (...)[];
file_format: (...) | (...) | (...) | (...) | (...);
file_properties: {
allowed_social_networks: ...;
aspect_ratio: ...;
duration: ...;
height: ...;
size_in_bytes: ...;
width: ...;
};
file_type: (...)
| (...);
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
};
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[]total: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
Optionalpublications?: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
by_state: { state?: string; total?: number }[];
published_by_day: {
day?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
total: number;
} & { previous_total?: number }range: {
from_date: string;
previous_from_date: string;
previous_to_date: string;
to_date: string;
}from_date: string
Format: date-time
previous_from_date: string
Format: date-time
previous_to_date: string
Format: date-time
to_date: string
Format: date-time
DashboardDashboardAiPlanRef: {
_id: string;
creation_date: string;
credits_spent?: number;
error?: {
code: number;
data?: { [key: string]: unknown };
message: string;
};
generation_end_date?: string;
prompt?: string;
publications?: string[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
}_id: string
creation_date: string
Format: date-time
Optionalcredits_spent?: numberOptionalerror?: { code: number; data?: { [key: string]: unknown }; message: string }Optionalgeneration_end_date?: stringFormat: date-time
Optionalprompt?: stringOptionalpublications?: string[]state: "pending" | "generating" | "generated" | "validated" | "failed" | "cancelled"
DashboardDashboardPublicationRef: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
text?: string;
}_id: string
Optionalcreation_date?: stringFormat: date-time
Optionalname?: stringOptionalpublication_errors?: { code: number; data?: { [key: string]: unknown }; message: string }[]Optionalpublication_warnings?: { code: number; data?: { [key: string]: unknown }; message: string }[]Description
What still has to be done by hand on the network for a publication that DID go out. Same shape as
publication_errors, and an empty array when there is nothing to do.It is a separate field because these are not failures: the publication stays in state `sended` and must **not** be retried, because retrying would publish it twice. Like `publication_errors`, it belongs to the last attempt. Today there is one code. **2400** (YouTube): YouTube accepted the upload but did not make the video public, so YouTube Studio shows it as a draft or private until someone sets its audience and visibility there. The upload does not fail when this happens; PlanVortex reads the video back right after uploading it to find out. `data` carries `requested_privacy_status`, `privacy_status` (what YouTube actually left), `upload_status`, `made_for_kids` and `studio_url`, the YouTube Studio page where it is finished.Optionalpublish_date?: stringFormat: date-time
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"Optionaltext?: string
DashboardDashboardRange: {
from_date: string;
previous_from_date: string;
previous_to_date: string;
to_date: string;
}from_date: string
Format: date-time
previous_from_date: string
Format: date-time
previous_to_date: string
Format: date-time
to_date: string
Format: date-time
DashboardMetricName:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained"DashboardMetricRow: {
group: null | string;
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained";
value: number;
}group: null | string
name:
| "reach"
| "impressions"
| "followers"
| "comments"
| "engagement"
| "likes"
| "shares"
| "saves"
| "clicks"
| "video_views"
| "profile_views"
| "followers_gained"value: number
DashboardPlanUse: {
actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
}actual_asigned: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
actual_use: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}limits: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
DashboardPublicationsSummary: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
by_state: { state?: string; total?: number }[];
published_by_day: {
day?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[];
total: number;
}by_day: { day?: string; state?: string; total?: number }[]
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[]by_state: { state?: string; total?: number }[]
published_by_day: {
day?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
total?: number;
}[]total: number
DashboardTopPublication: {
collected_date?: string;
engagement_base?: "reach" | "impressions" | "followers";
id_publication: string;
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
};
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}Description
One row of the ranking. It comes out of the stats aggregation, not out of the publications collection, so it does not have the shape of a
Publication: there is no_id(the identifier isid_publication) and the content travels nested underpublication.Only publications that have already been measured can appear here. For a listing that includes the unmeasured ones, use `GET /organizations/{id}/publications/stats`.Optionalcollected_date?: stringFormat: date-time
Optionalengagement_base?: "reach" | "impressions" | "followers"id_publication: string
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
publication: {
external_identifier?: string;
files?: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
publication_type?: string;
text?: string;
title?: string;
url?: string;
}Optionalpublish_date?: stringFormat: date-time
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"
Error: { code: number; data?: { [key: string]: unknown }; message: string }
Description
Error payload returned by every failing request.
**Classify by `code`, never by the HTTP status.** Every domain error travels with HTTP 400 — an expired token, a disconnected account, an exhausted plan quota and a text that is too long are all 400. Only error 520 (permissions) answers 401, and an unexpected failure answers 500. The catalogue grows with the product, so treat an unknown `code` as a generic failure instead of rejecting it.code: number
Description
PlanVortex error code. Ranges: 500-554 auth, tokens, client apps and connect sessions · 601-612 user · 700-716 social accounts · 800-810 files · 900-996 publications · 1000-1003 general · 1100-1111 organizations · 1200-1207 roles · 1300-1308 client plan · 1400-1408 organization plan · 1500-1512 messaging · 1600-1601 contacts · 1900-1906 payments · 2000-2099 products · 2100-2199 AI plans · 2200-2299 integrations · 2600-2699 comments, the ones that no longer fit in 945-948.
Optionaldata?: { [key: string]: unknown }message: string
FileProperties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
}allowed_social_networks: string[]
aspect_ratio: { text: string; value: number }
text: string
value: number
duration: number
height: number
size_in_bytes: number
width: number
IntegrationsGoogleDriveConnectRequest: { code: string; provider: "google_drive" }
code: string
provider: "google_drive"
IntegrationsIntegration: {
_id: string;
config: {
api_base?: "wp-json" | "rest_route";
auth_mode?: "query" | "basic";
auto_publish?: boolean;
currency?: string;
id_accounts?: string[];
import_image?: boolean;
key_ending?: string;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
tax_location_missing?: boolean;
template?: string;
url?: string;
};
connected: boolean;
creation_date: string;
enabled: boolean;
error_code?: null
| number;
external_identifier?: string;
id_client: string;
id_organization: string;
last_used_date?: string;
name: string;
provider: "google_drive" | "rss" | "woocommerce";
}_id: string
config: {
api_base?: "wp-json" | "rest_route";
auth_mode?: "query" | "basic";
auto_publish?: boolean;
currency?: string;
id_accounts?: string[];
import_image?: boolean;
key_ending?: string;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
tax_location_missing?: boolean;
template?: string;
url?: string;
}Optionalapi_base?: "wp-json" | "rest_route"Optionalauth_mode?: "query" | "basic"Optionalauto_publish?: booleanOptionalcurrency?: stringOptionalid_accounts?: string[]Optionalimport_image?: booleanOptionalkey_ending?: stringOptionallast_checked?: stringFormat: date-time
Optionalpublication_type?: stringOptionalseen_guids?: string[]Optionaltax_location_missing?: booleanDescription
woocommerce. true when the store's API gives prices WITHOUT tax, labelled as tax included. It happens with the default customer location set to geolocate (or to no location), prices entered without tax and tax based on the customer's address: an API request has no customer, so WooCommerce has nowhere to charge tax, andprice_htmlreads "20,00 € IVA incluido" where the shop charges 24,20 €. While it is true, the store's taxable products come back without a price rather than with a wrong one; products with no tax keep theirs. It is checked when connecting, so after fixing the setting (WooCommerce → Settings → General → Default customer location → Shop country/region) the store has to be reconnected. Always present on a store, also asfalse.Optionaltemplate?: stringOptionalurl?: string
connected: boolean
creation_date: string
Format: date-time
enabled: boolean
Optionalerror_code?: null | numberDescription
PlanVortex error code of the last failure (2203 token revoked, 2205 feed unreachable, 2211 the store rejected its key, 924 no publication allowance left…). 2219 is not a failure: a store connected with the button is being checked, for a few seconds; if it stays there, the check never finished and the store has to be reconnected.
Optionalexternal_identifier?: stringid_client: string
id_organization: string
Optionallast_used_date?: stringFormat: date-time
name: string
provider: "google_drive" | "rss" | "woocommerce"
IntegrationsIntegrationCatalogPage: {
items: {
available: boolean;
description?: string;
external_id: string;
image_url?: string;
name: string;
permalink?: string;
price?: string;
}[];
next_cursor?: string;
}items: {
available: boolean;
description?: string;
external_id: string;
image_url?: string;
name: string;
permalink?: string;
price?: string;
}[]Optionalnext_cursor?: string
IntegrationsIntegrationCatalogProduct: {
available: boolean;
description?: string;
external_id: string;
image_url?: string;
name: string;
permalink?: string;
price?: string;
}available: boolean
Optionaldescription?: stringexternal_id: string
Optionalimage_url?: stringname: string
Optionalpermalink?: stringOptionalprice?: stringDescription
Text ready to be copied verbatim, as the store displays it: with its tax suffix, its currency symbol and the range of a variable product ("36,30 € - 48,40 € IVA incluido"); for a product on sale, the sale price alone. Never a number to do arithmetic with. Absent = no price: the product has none, or it is taxable and the store's
config.tax_location_missingis true.
IntegrationsIntegrationConfig: {
api_base?: "wp-json" | "rest_route";
auth_mode?: "query" | "basic";
auto_publish?: boolean;
currency?: string;
id_accounts?: string[];
import_image?: boolean;
key_ending?: string;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
tax_location_missing?: boolean;
template?: string;
url?: string;
}Optionalapi_base?: "wp-json" | "rest_route"Optionalauth_mode?: "query" | "basic"Optionalauto_publish?: booleanOptionalcurrency?: stringOptionalid_accounts?: string[]Optionalimport_image?: booleanOptionalkey_ending?: stringOptionallast_checked?: stringFormat: date-time
Optionalpublication_type?: stringOptionalseen_guids?: string[]Optionaltax_location_missing?: booleanDescription
woocommerce. true when the store's API gives prices WITHOUT tax, labelled as tax included. It happens with the default customer location set to geolocate (or to no location), prices entered without tax and tax based on the customer's address: an API request has no customer, so WooCommerce has nowhere to charge tax, andprice_htmlreads "20,00 € IVA incluido" where the shop charges 24,20 €. While it is true, the store's taxable products come back without a price rather than with a wrong one; products with no tax keep theirs. It is checked when connecting, so after fixing the setting (WooCommerce → Settings → General → Default customer location → Shop country/region) the store has to be reconnected. Always present on a store, also asfalse.Optionaltemplate?: stringOptionalurl?: string
IntegrationsIntegrationFormField: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type:
| "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}Optionaldefault?: unknownname: string
Optionaloptions?: string[]required: boolean
type: "boolean" | "text" | "textarea" | "url" | "select" | "accounts" | "secret"
Description
accountsis a picker of the organization's accounts.secretis a credential (WooCommerce's consumer secret): mask it, never prefill it when editing, and mark the input as a new password (autocomplete="new-password"), or the browser's password manager fills it with the user's own PlanVortex password and the store answers2211.
IntegrationsIntegrationProvider: {
accepted_formats: string[];
catalog: boolean;
config_fields: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type:
| "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}[];
connect_link: boolean;
connect_link_fields: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type: | "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}[];
content_feed: boolean;
file_import: boolean;
provider: "google_drive"
| "rss"
| "woocommerce";
requires_oauth: boolean;
}accepted_formats: string[]
catalog: boolean
config_fields: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type:
| "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}[]connect_link: boolean
Description
Can be connected by sending the user to
GET .../integrations/{provider}/connect_link: Google Drive (its OAuth) and WooCommerce (the store's approval button, which creates the key without anyone copying it). A provider with a link can ALSO haveconfig_fields: a WooCommerce store accepts API keys by hand too.connect_link_fields: {
default?: unknown;
name: string;
options?: string[];
required: boolean;
type:
| "boolean"
| "text"
| "textarea"
| "url"
| "select"
| "accounts"
| "secret";
}[]content_feed: boolean
file_import: boolean
provider: "google_drive" | "rss" | "woocommerce"
requires_oauth: boolean
IntegrationsIntegrationProviderName: "google_drive" | "rss" | "woocommerce"
IntegrationsRssConfig: {
auto_publish?: boolean;
id_accounts?: string[];
import_image?: boolean;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
template?: string;
url?: string;
}Optionalauto_publish?: booleanOptionalid_accounts?: string[]Optionalimport_image?: booleanOptionallast_checked?: stringFormat: date-time
Optionalpublication_type?: stringOptionalseen_guids?: string[]Optionaltemplate?: stringOptionalurl?: string
IntegrationsRssConnectRequest: {
auto_publish?: boolean;
id_accounts: string[];
import_image?: boolean;
provider: "rss";
publication_type?: string;
template?: string;
url: string;
}Optionalauto_publish?: booleanid_accounts: string[]
Optionalimport_image?: booleanprovider: "rss"
Optionalpublication_type?: stringOptionaltemplate?: stringurl: string
IntegrationsWooCommerceConnectRequest: {
consumer_key: string;
consumer_secret: string;
provider: "woocommerce";
url: string;
}consumer_key: string
consumer_secret: string
provider: "woocommerce"
url: string
Message: {
_id: string;
contact_id?:
| string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
creation_date: string;
element_external_id?: string;
from_contact_id?: | string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
id_account: string;
in_response_external_id?: string;
in_response_to?: string;
message_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
read: boolean;
text?: string;
}Description
A message exchanged with a contact.
**Careful with the three reference fields.** `contact_id`, `from_contact_id` and `message_options.files` arrive **populated** — the whole object, not the identifier — in the messages list and in the webhook PlanVortex posts to your app, and as plain identifiers everywhere else. The types say `string | object` because both really happen._id: string
Optionalcontact_id?:
| string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
}creation_date: string
Format: date-time
Optionalelement_external_id?: stringOptionalfrom_contact_id?:
| string
| {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string
| number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
}id_account: string
Optionalin_response_external_id?: stringOptionalin_response_to?: stringmessage_errors: { code: number; data?: { [key: string]: unknown }; message: string }[]
message_options: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
}files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[]files_urls: { mime_type?: string; url?: string }[]
OptionalmetaElements?: { [key: string]: unknown }[]OptionalmetaQuickReplies?: { [key: string]: unknown }[]Optionalpayload?: stringOptionaltemplate_language?: stringOptionaltemplate_name?: stringOptionaltemplate_parameters?: string[]Description
For a
template_messagewhose body has variables: their values, in order. The first one fills{{1}}, the second{{2}}, and so on. Without them WhatsApp rejects a template that has variables, so a reminder with the customer's name and time needs this. Each value is a non-empty string with no line breaks, no tabs and no more than four consecutive spaces; anything else answers1511withdata.field=template_parametersanddata.indexpointing at the bad value. Only positional body variables are supported: named variables ({{name}}) and variables in the header or in a button URL are not sent yet.OptionalwhatsappInteractive?: { [key: string]: unknown }
message_type:
| "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message"read: boolean
Optionaltext?: string
MessageOptions: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
}files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[]files_urls: { mime_type?: string; url?: string }[]
OptionalmetaElements?: { [key: string]: unknown }[]OptionalmetaQuickReplies?: { [key: string]: unknown }[]Optionalpayload?: stringOptionaltemplate_language?: stringOptionaltemplate_name?: stringOptionaltemplate_parameters?: string[]Description
For a
template_messagewhose body has variables: their values, in order. The first one fills{{1}}, the second{{2}}, and so on. Without them WhatsApp rejects a template that has variables, so a reminder with the customer's name and time needs this. Each value is a non-empty string with no line breaks, no tabs and no more than four consecutive spaces; anything else answers1511withdata.field=template_parametersanddata.indexpointing at the bad value. Only positional body variables are supported: named variables ({{name}}) and variables in the header or in a button URL are not sent yet.OptionalwhatsappInteractive?: { [key: string]: unknown }
MessagesConversation: {
contact: {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string | number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
};
date: string;
unread_messages: number;
}contact: {
_id: string;
creation_date: string;
creator_keycloak_identifier?: string;
extra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string | number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
};
id_organization: string;
last_contact_update: string;
name?: string;
profile_image?: string;
social_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[];
}_id: string
creation_date: string
Format: date-time
Optionalcreator_keycloak_identifier?: stringOptionalextra_data?: {
address?: string;
boolean_property?: boolean;
boolean_property2?: boolean;
building?: string | number;
city?: string;
coords?: number[];
country?: string;
country_code?: string;
door?: string | number;
floor?: string | number;
number?: string | number;
number_property?: number;
number_property2?: number;
place_id?: string;
state?: string;
string_property?: string;
string_property2?: string;
zip_code?: string | number;
}Optionaladdress?: stringOptionalboolean_property?: booleanOptionalboolean_property2?: booleanOptionalbuilding?: string | numberOptionalcity?: stringOptionalcoords?: number[]Optionalcountry?: stringOptionalcountry_code?: stringOptionaldoor?: string | numberOptionalfloor?: string | numberOptionalnumber?: string | numberOptionalnumber_property?: numberOptionalnumber_property2?: numberOptionalplace_id?: stringOptionalstate?: stringOptionalstring_property?: stringOptionalstring_property2?: stringOptionalzip_code?: string | number
id_organization: string
last_contact_update: string
Format: date-time
Optionalname?: stringOptionalprofile_image?: stringsocial_identifiers: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}[]
date: string
Format: date-time
unread_messages: number
MessagesConversationTotals:
| { total: number }
| {
group: "day" | "month" | "year";
stats: { groupValue: number; totalConversations: number }[];
}MessagesMessageInput: {
in_response_external_id?: string;
message_options?: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
};
message_type: | "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message";
text?: string;
}Description
What you send to write a message.
`comment_message` and `publication_message` need `in_response_external_id`, the identifier of the comment or the publication being answered ON THE NETWORK. The endpoint did not read it from the body until 2026-08-24, which left both types unreachable from the public API; it does now.Optionalin_response_external_id?: stringDescription
Required by
comment_messageandpublication_message, and ignored by every other type (error1510when it is missing). It is the identifier the NETWORK gives: a comment'sexternal_idor a publication'sexternal_identifier, never a PlanVortex_id.Only Facebook and Instagram do anything with it: `comment_message` sends a private reply to a public comment (Meta's `recipient.comment_id`) and `publication_message` attaches the post as a `MEDIA_SHARE`.Optionalmessage_options?: {
files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[];
files_urls: { mime_type?: string; url?: string }[];
metaElements?: { [key: string]: unknown }[];
metaQuickReplies?: { [key: string]: unknown }[];
payload?: string;
template_language?: string;
template_name?: string;
template_parameters?: string[];
whatsappInteractive?: { [key: string]: unknown };
}files: (
| string
| {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}
)[]files_urls: { mime_type?: string; url?: string }[]
OptionalmetaElements?: { [key: string]: unknown }[]OptionalmetaQuickReplies?: { [key: string]: unknown }[]Optionalpayload?: stringOptionaltemplate_language?: stringOptionaltemplate_name?: stringOptionaltemplate_parameters?: string[]Description
For a
template_messagewhose body has variables: their values, in order. The first one fills{{1}}, the second{{2}}, and so on. Without them WhatsApp rejects a template that has variables, so a reminder with the customer's name and time needs this. Each value is a non-empty string with no line breaks, no tabs and no more than four consecutive spaces; anything else answers1511withdata.field=template_parametersanddata.indexpointing at the bad value. Only positional body variables are supported: named variables ({{name}}) and variables in the header or in a button URL are not sent yet.OptionalwhatsappInteractive?: { [key: string]: unknown }
message_type:
| "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message"Optionaltext?: string
MessageType:
| "simple_message"
| "file_message"
| "comment_message"
| "publication_message"
| "quick_reply_message"
| "button_message"
| "elements_message"
| "postback_message"
| "template_message"
| "interactive_message"NormalizedMetrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Description
Metrics translated to a common vocabulary shared by every network, which is what makes two networks comparable and summable (each network names them differently:
page_post_engagements,total_interactions,views…).**A missing key means the network does not publish that metric** — it is never an implicit zero. A key present with value `0` means it was measured and came out zero. Never default a missing key to 0 when displaying it. `engagement` is the network's own total when it provides one, and otherwise the sum of likes, comments, shares, saves and clicks. Video views are deliberately excluded from it: a view is not an interaction.Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
Organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}_id: string
Optionalactual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}Description
The slice of the client's plan assigned to this organization. Absent when nothing was assigned, and then the organization shares whatever its nearest parent with a plan has — or, failing that, the client's unassigned remainder. Ask
GET /organizations/{id_organization}/limitsfor the effective numbers instead of reading this.accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
Optionalactual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}Optionalai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
}Optionalaudience?: stringOptionalavoid?: stringOptionalblog_url?: stringOptionalbrand_name?: stringOptionaldefault_tone?: stringOptionaldescription?: stringOptionalkeywords?: string[]Optionalnotes?: stringOptionalproducts?: stringOptionalsector?: stringOptionalshop_url?: stringOptionalsocial_urls?: string[]Optionalvalue_proposition?: stringOptionalwebsite?: string
creation_date: string
Format: date-time
id_client: string
name: string
Optionalparent_organization?: stringOptionalsocial_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
}Optionaldiscord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
}Optionalapplication_name?: stringOptionalclient_id?: stringOptionalhas_bot_token?: booleanOptionalhas_client_secret?: booleanOptionalverified_date?: stringFormat: date-time
Optionalstats_settings?: { auto_refresh_twitter: boolean }auto_refresh_twitter: boolean
OrganizationsLimit: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
OrganizationsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
name: string;
}Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
name: string
OrganizationsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}[];
total: number;
}OrganizationsOrganizationOne: {
organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
};
}organization: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
actual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
ai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
};
creation_date: string;
id_client: string;
name: string;
parent_organization?: string;
social_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
};
stats_settings?: { auto_refresh_twitter: boolean };
}_id: string
Optionalactual_asigned?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}Description
The slice of the client's plan assigned to this organization. Absent when nothing was assigned, and then the organization shares whatever its nearest parent with a plan has — or, failing that, the client's unassigned remainder. Ask
GET /organizations/{id_organization}/limitsfor the effective numbers instead of reading this.accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
Optionalactual_use?: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}Optionalai_context?: {
audience?: string;
avoid?: string;
blog_url?: string;
brand_name?: string;
default_tone?: string;
description?: string;
keywords?: string[];
notes?: string;
products?: string;
sector?: string;
shop_url?: string;
social_urls?: string[];
value_proposition?: string;
website?: string;
}Optionalaudience?: stringOptionalavoid?: stringOptionalblog_url?: stringOptionalbrand_name?: stringOptionaldefault_tone?: stringOptionaldescription?: stringOptionalkeywords?: string[]Optionalnotes?: stringOptionalproducts?: stringOptionalsector?: stringOptionalshop_url?: stringOptionalsocial_urls?: string[]Optionalvalue_proposition?: stringOptionalwebsite?: string
creation_date: string
Format: date-time
id_client: string
name: string
Optionalparent_organization?: stringOptionalsocial_credentials?: {
discord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
};
}Optionaldiscord?: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
}Optionalapplication_name?: stringOptionalclient_id?: stringOptionalhas_bot_token?: booleanOptionalhas_client_secret?: booleanOptionalverified_date?: stringFormat: date-time
Optionalstats_settings?: { auto_refresh_twitter: boolean }auto_refresh_twitter: boolean
OrganizationsOrganizationUpdate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
};
stats_settings?: { auto_refresh_twitter: boolean };
}Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
Optionalstats_settings?: { auto_refresh_twitter: boolean }auto_refresh_twitter: boolean
OrganizationsRolesOrganizationRole: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
}Optional_id?: stringOptionalcreation_date?: stringFormat: date-time
Optionaldefault?: booleanOptionalid_organization?: stringOptionalname?: stringOptionalpermissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[]Optionaltotal_users?: number
OrganizationsRolesOrganizationRoleInput: {
name: string;
permissions: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
}name: string
permissions: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[]
OrganizationsRolesOrganizationRoleList: {
roles?: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
}[];
total?: number;
}Optionalroles?: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
}[]Optionaltotal?: number
OrganizationsRolesOrganizationRoleOne: {
rol?: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
};
}Optionalrol?: {
_id?: string;
creation_date?: string;
default?: boolean;
id_organization?: string;
name?: string;
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
total_users?: number;
}Optional_id?: stringOptionalcreation_date?: stringFormat: date-time
Optionaldefault?: booleanOptionalid_organization?: stringOptionalname?: stringOptionalpermissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[]Optionaltotal_users?: number
OrganizationsRolesPermissionList: {
permissions?: (
| "organization:create"
| "organization:update"
| "organization:read"
| "organization:delete"
| "organization_roles:create"
| "organization_roles:update"
| "organization_roles:read"
| "organization_roles:delete"
| "organization_users_roles:read"
| "organization_users_roles:create"
| "organization_users_roles:delete"
| "accounts:create"
| "accounts:update"
| "accounts:read"
| "accounts:delete"
| "products:create"
| "products:update"
| "products:read"
| "products:delete"
| "files:create"
| "files:update"
| "files:read"
| "files:delete"
| "publications:create"
| "publications:update"
| "publications:read"
| "publications:delete"
| "account_stats:read"
| "publication_stats:read"
| "messages:create"
| "messages:read"
| "messages:delete"
| "contacts:create"
| "contacts:read"
| "contacts:update"
| "contacts:delete"
| "ai_plans:create"
| "ai_plans:read"
| "ai_plans:update"
| "ai_plans:delete"
)[];
}OrganizationsRolesUserInOrganization: {
email?: string;
enabled?: boolean;
firstname?: string;
id?: string;
lastname?: string;
roles?: { _id?: string; name?: string }[];
username?: string;
}Optionalemail?: stringFormat: email
Optionalenabled?: booleanOptionalfirstname?: stringOptionalid?: stringOptionallastname?: stringOptionalroles?: { _id?: string; name?: string }[]Optionalusername?: string
OrganizationsRolesUserInOrganizationList: {
total?: number;
users?: {
email?: string;
enabled?: boolean;
firstname?: string;
id?: string;
lastname?: string;
roles?: { _id?: string; name?: string }[];
username?: string;
}[];
}Optionaltotal?: numberOptionalusers?: {
email?: string;
enabled?: boolean;
firstname?: string;
id?: string;
lastname?: string;
roles?: { _id?: string; name?: string }[];
username?: string;
}[]
OrganizationsSocialCredentialsInput: { bot_token?: string; client_id?: string; client_secret?: string }
Optionalbot_token?: stringOptionalclient_id?: stringOptionalclient_secret?: string
OrganizationsUser: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
}OrganizationsUserList: {
total?: number;
users?: {
email?: string;
firstname?: string;
id?: string;
lastname?: string;
username?: string;
}[];
}PlanData: {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}Description
The resources a plan grants. On a client it is what was contracted; on an organization, the slice of it that was assigned. The sum across all the organizations of a client can never exceed what the client has contracted.
Users are NOT here: every plan has unlimited users, so they are neither charged nor split between organizations. They are still counted, in `PlanUseData.users`. There are no `artificial_inteligence`, `whatsapp` or `stats` flags either: statistics and WhatsApp are on every plan, and what gates AI is `ai_credits` — a plan with credits has AI, and Free has zero.accounts: number
Optionalai_credits?: numberOptionalapps?: numberDescription
Apps this plan allows: 1 on Free, 2 on Basic, 5 on Pro, 10 on Custom. Each one is a
client_idwith a secret, so each one is a key to the whole public API — which every plan has, Free included. Unlike accounts or storage this is NOT split between organizations: an app belongs to the client. On a use payload it is how many exist right now.integrations: number
space: number
Optionaltwitter_credits?: number
PlanUseData: { publications?: number; users?: number } & {
accounts: number;
ai_credits?: number;
apps?: number;
integrations: number;
space: number;
twitter_credits?: number;
}ProductsProduct: {
additional_image_urls?: string[];
availability?:
| "pending"
| "in stock"
| "out of stock"
| "preorder"
| "available for order"
| "discontinued"
| "mark_as_sold";
brand?: string;
category?: string;
color?: string;
condition?: | "new"
| "refurbished"
| "used"
| "used_like_new"
| "used_good"
| "used_fair"
| "cpo"
| "open_box_new";
currency: string;
description?: string;
id?: string;
image_url: string;
name: string;
price: number;
retailer_id: string;
url?: string;
} & { [key: string]: unknown }ProductsProductCatalog: {
default_image_url?: string;
feed_count?: number;
id?: string;
is_catalog_segment?: boolean;
is_local_catalog?: boolean;
name?: string;
product_count?: number;
} & { [key: string]: unknown }ProductsProductCatalogInput: { name: string }
ProductsProductInput: {
additional_image_urls?: string[];
availability?:
| "pending"
| "in stock"
| "out of stock"
| "preorder"
| "available for order"
| "discontinued"
| "mark_as_sold";
brand?: string;
category?: string;
color?: string;
condition?: | "new"
| "refurbished"
| "used"
| "used_like_new"
| "used_good"
| "used_fair"
| "cpo"
| "open_box_new";
currency: string;
description?: string;
id?: string;
image_url: string;
name: string;
price: number;
retailer_id: string;
url?: string;
} & { [key: string]: unknown }Publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}_id: string
Optionalai_generated?: { image: boolean; text: boolean }image: boolean
text: boolean
creation_date: string
Format: date-time
Optionaldestination?: { id?: string; name?: string; section_id?: string; section_name?: string }Optionalid?: stringDescription
The board id. Always a string, never a number: Pinterest's ids are long integers, so a client that sends one as a JSON number has already lost digits to rounding before the request arrives. That is refused —
publication_errors[].code = 987withdata.reason = "invalid_id"— rather than published to some other board. Sending the board's name instead of its id fails the same way, which is the likeliest first mistake of an integration.Optionalname?: stringOptionalsection_id?: stringOptionalsection_name?: string
Optionalengagement_base?: "reach" | "impressions" | "followers"Optionalexternal_identifier?: stringOptionalextra_data?: { [key: string]: unknown }Description
What one network needs to remember about this publication and that has no common field. Absent on a publication whose network needs nothing, which is almost all of them.
Today only `telegram` writes here, and only `telegram_message_ids`: the ids of every message an album turned into, because deleting the album means deleting all of them.files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[]id_account:
| string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}Optionalid_integration?: stringid_organization: string
Optionallink?: stringDescription
The destination link: where the publication takes whoever clicks it. Not to be confused with
url, which is the link to the publication on the network and only exists once it is published.Only the networks that answer `link: true` in `GET /social_capabilities` carry it — today `pinterest` alone, where a pin has a `link` field of its own and sending traffic somewhere is the whole point of publishing there. Putting the URL inside `text` instead leaves it visible and unclickable. **On every other network the field is deleted on save**, like `destination`.Optionalmade_for_kids?: booleanOptionalmetrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
Optionalname?: stringOptionalnext_stats_update?: stringFormat: date-time
Optionalpending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
}Optionaldata?: { [key: string]: unknown }Optionaldeadline?: stringFormat: date-time
Optionalnext_check?: stringFormat: date-time
Optionaltemp_keys?: string[]
publication_errors: { code: number; data?: { [key: string]: unknown }; message: string }[]
Description
Why the publication failed, one entry per problem. It is an array, and it is empty on a publication that has not failed.
For a scheduled X (Twitter) publication that runs out of credits at publish time, `code` is 940 and `data` is `{ used, limit }`; the publication stays in state `withErrors`. No webhook announces it: read the publication to find out. On Instagram, two codes tell you whether a retry makes sense. **998**: Meta rejected the media while processing it (a codec, a duration, a URL it could not download). `data` carries `container_id`, `status_code` and, when Meta gives one, its reason in `status`. Retrying the same file fails the same way: change it first. **999**: Meta had not finished processing the media 10 minutes after it was sent. `data` carries `container_ids` and `minutes`. The file is not the problem, and a retry usually works.publication_type: "profile" | "page" | "group" | "reels" | "stories" | "message"
Optionalpublication_warnings?: { code: number; data?: { [key: string]: unknown }; message: string }[]Description
What still has to be done by hand on the network for a publication that DID go out. Same shape as
publication_errors, and an empty array when there is nothing to do.It is a separate field because these are not failures: the publication stays in state `sended` and must **not** be retried, because retrying would publish it twice. Like `publication_errors`, it belongs to the last attempt. Today there is one code. **2400** (YouTube): YouTube accepted the upload but did not make the video public, so YouTube Studio shows it as a draft or private until someone sets its audience and visibility there. The upload does not fail when this happens; PlanVortex reads the video back right after uploading it to find out. `data` carries `requested_privacy_status`, `privacy_status` (what YouTube actually left), `upload_status`, `made_for_kids` and `studio_url`, the YouTube Studio page where it is finished.Optionalpublish_date?: stringFormat: date-time
Optionalreply_control?: "everyone" | "accounts_you_follow" | "mentioned_only" | "followers_only"Description
Who can reply to the publication, on the networks that answer
reply_control: trueinGET /social_capabilities(todaythreads). Absent means the network's default, which is anyone. It is set when the publication goes out and cannot be changed afterwards.**On every other network the field is deleted on save**, like `link`.retries: number
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"state: "ready" | "withErrors" | "sended" | "draft" | "publishing"
Description
draftis never sent;readyis scheduled;publishingis in the network's hands right now;sendedwent out;withErrorsfailed and carries the reason inpublication_errors.`publishing` usually lasts a few seconds, but it can last **up to 10 minutes** when the network is still processing a video (today, Instagram). Then `pending_publish` is present: wait and read the publication again, do not retry it.Optionalstatistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
}Optionalangers?: numberOptionalbookmarks?: numberOptionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollows?: numberOptionalhahas?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalloves?: numberOptionalnegative_feedback?: numberOptionaloutbound_clicks?: numberOptionalpage_likes?: numberOptionalpin_clicks?: numberOptionalplayback_0_count?: numberOptionalplayback_100_count?: numberOptionalplayback_25_count?: numberOptionalplayback_50_count?: numberOptionalplayback_75_count?: numberOptionalprofile_activity?: numberOptionalprofile_visits?: numberOptionalquotes?: numberOptionalreach?: numberOptionalreactions?: numberOptionalreactions_by_emoji?: { [key: string]: number }Optionalreplys?: numberOptionalretwets?: numberOptionalsaved?: numberOptionalsaves?: numberOptionalshare?: numberOptionalshareMentions?: numberOptionalshares?: numberOptionalsorrys?: numberOptionalurl_link_clicks?: numberOptionaluser_profile_clicks?: numberOptionalvideo_views?: numberOptionalviews?: numberOptionalwows?: number
Optionalstats_updated_date?: stringFormat: date-time
Optionaltext?: stringOptionaltitle?: stringOptionalurl?: stringOptionalvisibility?: "public" | "unlisted" | "private"
PublicationAiGenerated: { image: boolean; text: boolean }
image: boolean
text: boolean
PublicationDestination: { id?: string; name?: string; section_id?: string; section_name?: string }
Description
Where inside the account a publication goes, on the networks where choosing the account is not yet choosing the destination. Today that is
pinterestalone, where it is the board the pin is saved to.Ask `destinations` in `GET /social_capabilities` instead of keeping a list of your own, and read the account's boards with `GET /organizations/{id_organization}/accounts/{id_account}/destinations`. **On Pinterest it is required.** A publication created without it is created in state `withErrors` with `publication_errors[].code = 987` and the background job will not attempt it — the same treatment as a YouTube video with no title, and for the same reason: a scheduled publication that dies at 3 a.m. over a board that was missing from the start is a failure that could have been told to the person while they were still there. **On every other network the field is deleted, not rejected.** A `destination` on a Facebook publication would be a field that does nothing, and giving it back in the response would be worse than dropping it. `name` and `section_name` are labels for display ("Recipes > Desserts"). The server never checks them and nothing is decided by them: what publishes is `id`.Optionalid?: stringDescription
The board id. Always a string, never a number: Pinterest's ids are long integers, so a client that sends one as a JSON number has already lost digits to rounding before the request arrives. That is refused —
publication_errors[].code = 987withdata.reason = "invalid_id"— rather than published to some other board. Sending the board's name instead of its id fails the same way, which is the likeliest first mistake of an integration.Optionalname?: stringOptionalsection_id?: stringOptionalsection_name?: string
PublicationPending: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
}Description
Present only while the network is still processing what was sent, and PlanVortex is waiting to publish it. Today that happens on Instagram alone, when Meta takes longer than the ~30 seconds the request waits to process the media. In practice, that means videos.
The publication stays in state `publishing`, and the background job asks Instagram again about once a minute until it goes out (`sended`) or fails (`withErrors`). It gives up 10 minutes after the media was sent to Instagram, and then the publication ends in `withErrors` with code 999. The object disappears as soon as the publication is resolved. **Wait for it. Do not retry it and do not create it again**: it has not failed, and a second publication would put the same video out twice. There is no webhook for the outcome: read the publication again after `next_check`. While this object is present the publication **cannot be updated** (error 921), for the same reason.Optionaldata?: { [key: string]: unknown }Optionaldeadline?: stringFormat: date-time
Optionalnext_check?: stringFormat: date-time
Optionaltemp_keys?: string[]
PublicationsDestination: {
description?: string;
id: string;
image?: string;
name: string;
privacy?: string;
sections?: { id: string; name: string }[];
}Optionaldescription?: stringid: string
Optionalimage?: stringname: string
Optionalprivacy?: stringOptionalsections?: { id: string; name: string }[]
PublicationsPublicationInput: {
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
files?: string[];
link?: string;
made_for_kids?: boolean;
name?: string;
publication_type?: "profile"
| "page"
| "group"
| "reels"
| "stories";
publish_date?: string;
reply_control?:
| "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
social_network?: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state?: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
text?: string;
title?: string;
visibility?: "public" | "unlisted" | "private";
}Optionaldestination?: { id?: string; name?: string; section_id?: string; section_name?: string }Description
Where inside the account the publication goes. Required on the networks that answer
destinations: trueinGET /social_capabilities— todaypinterest, where it is the board — and deleted on every other one.Read the account's destinations with `GET /organizations/{id_organization}/accounts/{id_account}/destinations` and send back the `id` you got from there. Missing or malformed, the publication is still created, in state `withErrors` with `publication_errors[].code = 987` and a `data.reason` of `missing`, `invalid_id` or `invalid_section_id`. It is **not** checked against the network at creation: that would cost a call to Pinterest on every publication and make creating one depend on Pinterest answering. On an update, omitting it keeps the destination that was there.Optionalid?: stringDescription
The board id. Always a string, never a number: Pinterest's ids are long integers, so a client that sends one as a JSON number has already lost digits to rounding before the request arrives. That is refused —
publication_errors[].code = 987withdata.reason = "invalid_id"— rather than published to some other board. Sending the board's name instead of its id fails the same way, which is the likeliest first mistake of an integration.Optionalname?: stringOptionalsection_id?: stringOptionalsection_name?: string
Optionalfiles?: string[]Description
Identifiers of uploads previously created through the uploads endpoints, attached to this publication.
**On Slack the files travel inside the message**, not as publications of their own: up to 10 attachments counting images and videos together (`publication_errors[].code = 982` over it), each one under the `max_file_size_mb.slack` ceiling (code 983), and anything the upload itself refuses comes back as code 986. **On Pinterest a pin is an image or a video, never text alone** (code 922 with neither), and it is of one kind only: two to five images make a carousel — outside that range, code 990 — images and videos are not mixed and there is no more than one video (code 916). The weight ceilings are two orders of magnitude apart, so `max_file_size_mb.pinterest` is the **image** one (~20 MB) while a video is allowed far more; over either, code 996 with `data.max_mb`.Optionallink?: stringDescription
The destination link: where the publication takes whoever clicks it. Only on the networks that answer
link: trueinGET /social_capabilities— todaypinterest, where it is the whole point of a pin — and deleted on every other one. It is noturl, which is the link to the publication on the network once published.It is optional (a pin with no link is legitimate), but if it is sent it must be a real `http(s)://` URL of at most 2.048 characters: a bare domain such as `mysite.com/recipe` is created in state `withErrors` with `publication_errors[].code = 994` and `data.reason` of `invalid_url` or `too_long`. It is checked when the publication is **created**, not when it is published, so a scheduled pin does not die at 3 a.m. over a link that was already wrong. On an update: omit it to keep what was there, send `null` or `""` to remove it.Optionalmade_for_kids?: booleanDescription
Whether the video is made for kids. Only on the networks that answer
made_for_kids: trueinGET /social_capabilities(todayyoutube), and deleted on every other one. Absent meansfalse.The law (COPPA) and YouTube's policies require a video directed at children to be uploaded with `true`, and it is the **user's** call: if your software publishes on behalf of someone, ask them. YouTube then turns off features such as comments and personalised ads on that video. It must be a JSON boolean. Anything else (`"yes"`, `"no"`, `1`) is not guessed: the publication is still created, in state `withErrors` with `publication_errors[].code = 2501`. On an update: omit it to keep what was there, send `null` or `""` to go back to `false`.Optionalname?: stringOptionalpublication_type?: "profile" | "page" | "group" | "reels" | "stories"Description
Defaults to
profile. Not every network accepts every type, and an unsupported combination returns error 923. Allowed values are: facebook and instagram -> profile, reels, stories; twitter, linkedin, tiktok and youtube -> profile; whatsapp -> stories. YouTube has no separate type for Shorts: any vertical video of 3 minutes or less is classified as one automatically.Optionalpublish_date?: stringFormat: date-time
Optionalreply_control?: "everyone" | "accounts_you_follow" | "mentioned_only" | "followers_only"Description
Who can reply to the publication. Only on the networks that answer
reply_control: trueinGET /social_capabilities(todaythreads), and deleted on every other one.- `everyone`: anyone. It is the network's default, and what applies when the field is omitted. - `followers_only`: only the account's followers. - `accounts_you_follow`: only the profiles the account follows. - `mentioned_only`: only the profiles mentioned in the text. **It is set when the publication goes out and cannot be changed afterwards**: Threads has no way to change it on a published post through its API. A value the network does not accept does not fail the request: the publication is still created, in state `withErrors` with `publication_errors[].code = 997`, whose `data` carries the `allowed` values. It is checked when the publication is **created**, so a scheduled post does not fail at 3 a.m. over a value that was already wrong. On an update: omit it to keep what was there, send `null` or `""` to go back to the network's default.Optionalsocial_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"Description
Network the publication targets. Required when creating: the request fails with error 702 if it is missing or not one of these values. It must match the network of the account in the path.
Not every connectable network publishes — a local business listing receives reviews, not posts — so this list is shorter than the one in `GET /social_networks`. Ask `GET /allowed_social_publications` rather than hardcoding it, because it grows.Optionalstate?: "ready" | "withErrors" | "sended" | "draft" | "publishing"Optionaltext?: stringDescription
Body text of the publication. Either
textor at least one entry infilesis required: if both are empty the publication is still created, but in statewithErrorswithpublication_errors[].code = 915. Maximum length depends on the network. On YouTube this is the video description (5,000 characters), and the publication must carry exactly one video file and no images — otherwise it is created in statewithErrorswithpublication_errors[].code = 943. For X (Twitter), a text containing a link costs 200 credits instead of 15.**On Telegram the limit depends on what else the publication carries**: 4.096 characters while it is text only, and **1.024** the moment it has an image or a video, because then the text is the caption of a photo, a video or an album and no longer a message. Over the limit it is created in state `withErrors` with `publication_errors[].code = 967`, whose `data` carries `characters`, `max_characters` and `has_media`. Both numbers are published, as `characters.telegram` and `characters.telegram_media` in `GET /social_limits`. **On Slack the limit is 4.000 characters** and it is counted over the text you send, not over what travels: `&`, `<` and `>` are escaped before publishing, so a text made of ampersands grows on the wire and is still measured here. Over the limit the publication is created in state `withErrors` with `publication_errors[].code = 981`. And because the escaped text is what is measured on the wire, a text that passed at 4.000 characters and is full of `&` is **trimmed** before going out — Slack does not reject a long `text`, it truncates it or splits it into several messages, and one publication showing up as two posts is worse. The text goes out **plain**: Slack speaks *mrkdwn* and not Markdown, and PlanVortex sends no `blocks`, so `**bold**` is published literally. **On Pinterest `text` is the pin's description**, at most 800 characters — the title is the separate `title` field, which is the first thing anyone arriving from Facebook gets wrong. Over it, `publication_errors[].code = 995` with `data.field = "description"`.Optionaltitle?: stringDescription
Title for the publication. Only some networks use it: optional on LinkedIn, and required on YouTube, where it is the video title and must be 100 characters or fewer — a publication without it, or with a longer one, is created in state
withErrorswithpublication_errors[].code = 944.**On Pinterest it is the pin's title**, optional and at most 100 characters; over it the publication is created in state `withErrors` with `publication_errors[].code = 995` and `data.field = "title"`.Optionalvisibility?: "public" | "unlisted" | "private"Description
Who can see the publication when it goes out. Only on the networks that answer
visibility: trueinGET /social_capabilities(todayyoutube), and deleted on every other one.- `public`: anyone. It is what applies when the field is omitted. - `unlisted`: only people with the link. It does not show on the channel or in search. - `private`: only the channel owner and the people they invite from YouTube Studio. YouTube's policies require this to be **the user's choice**: if your software publishes on behalf of someone, ask them. A value the network does not accept does not fail the request: the publication is still created, in state `withErrors` with `publication_errors[].code = 2500`, whose `data` carries the `allowed` values. It is checked when the publication is **created**, so a scheduled video does not fail at 3 a.m. over a value that was already wrong. If YouTube does not leave the video with the visibility that was asked for, the publication still ends up `sended` (the video is on the channel) and carries a warning in `publication_warnings` with `code = 2400`. On an update: omit it to keep what was there, send `null` or `""` to go back to `public`.
PublicationsPublicationList: {
publications: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}[];
total: number;
}PublicationsPublicationOne: {
publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
}publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}_id: string
Optionalai_generated?: { image: boolean; text: boolean }image: boolean
text: boolean
creation_date: string
Format: date-time
Optionaldestination?: { id?: string; name?: string; section_id?: string; section_name?: string }Optionalid?: stringDescription
The board id. Always a string, never a number: Pinterest's ids are long integers, so a client that sends one as a JSON number has already lost digits to rounding before the request arrives. That is refused —
publication_errors[].code = 987withdata.reason = "invalid_id"— rather than published to some other board. Sending the board's name instead of its id fails the same way, which is the likeliest first mistake of an integration.Optionalname?: stringOptionalsection_id?: stringOptionalsection_name?: string
Optionalengagement_base?: "reach" | "impressions" | "followers"Optionalexternal_identifier?: stringOptionalextra_data?: { [key: string]: unknown }Description
What one network needs to remember about this publication and that has no common field. Absent on a publication whose network needs nothing, which is almost all of them.
Today only `telegram` writes here, and only `telegram_message_ids`: the ids of every message an album turned into, because deleting the album means deleting all of them.files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[]id_account:
| string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}Optionalid_integration?: stringid_organization: string
Optionallink?: stringDescription
The destination link: where the publication takes whoever clicks it. Not to be confused with
url, which is the link to the publication on the network and only exists once it is published.Only the networks that answer `link: true` in `GET /social_capabilities` carry it — today `pinterest` alone, where a pin has a `link` field of its own and sending traffic somewhere is the whole point of publishing there. Putting the URL inside `text` instead leaves it visible and unclickable. **On every other network the field is deleted on save**, like `destination`.Optionalmade_for_kids?: booleanOptionalmetrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
Optionalname?: stringOptionalnext_stats_update?: stringFormat: date-time
Optionalpending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
}Optionaldata?: { [key: string]: unknown }Optionaldeadline?: stringFormat: date-time
Optionalnext_check?: stringFormat: date-time
Optionaltemp_keys?: string[]
publication_errors: { code: number; data?: { [key: string]: unknown }; message: string }[]
Description
Why the publication failed, one entry per problem. It is an array, and it is empty on a publication that has not failed.
For a scheduled X (Twitter) publication that runs out of credits at publish time, `code` is 940 and `data` is `{ used, limit }`; the publication stays in state `withErrors`. No webhook announces it: read the publication to find out. On Instagram, two codes tell you whether a retry makes sense. **998**: Meta rejected the media while processing it (a codec, a duration, a URL it could not download). `data` carries `container_id`, `status_code` and, when Meta gives one, its reason in `status`. Retrying the same file fails the same way: change it first. **999**: Meta had not finished processing the media 10 minutes after it was sent. `data` carries `container_ids` and `minutes`. The file is not the problem, and a retry usually works.publication_type: "profile" | "page" | "group" | "reels" | "stories" | "message"
Optionalpublication_warnings?: { code: number; data?: { [key: string]: unknown }; message: string }[]Description
What still has to be done by hand on the network for a publication that DID go out. Same shape as
publication_errors, and an empty array when there is nothing to do.It is a separate field because these are not failures: the publication stays in state `sended` and must **not** be retried, because retrying would publish it twice. Like `publication_errors`, it belongs to the last attempt. Today there is one code. **2400** (YouTube): YouTube accepted the upload but did not make the video public, so YouTube Studio shows it as a draft or private until someone sets its audience and visibility there. The upload does not fail when this happens; PlanVortex reads the video back right after uploading it to find out. `data` carries `requested_privacy_status`, `privacy_status` (what YouTube actually left), `upload_status`, `made_for_kids` and `studio_url`, the YouTube Studio page where it is finished.Optionalpublish_date?: stringFormat: date-time
Optionalreply_control?: "everyone" | "accounts_you_follow" | "mentioned_only" | "followers_only"Description
Who can reply to the publication, on the networks that answer
reply_control: trueinGET /social_capabilities(todaythreads). Absent means the network's default, which is anyone. It is set when the publication goes out and cannot be changed afterwards.**On every other network the field is deleted on save**, like `link`.retries: number
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"state: "ready" | "withErrors" | "sended" | "draft" | "publishing"
Description
draftis never sent;readyis scheduled;publishingis in the network's hands right now;sendedwent out;withErrorsfailed and carries the reason inpublication_errors.`publishing` usually lasts a few seconds, but it can last **up to 10 minutes** when the network is still processing a video (today, Instagram). Then `pending_publish` is present: wait and read the publication again, do not retry it.Optionalstatistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
}Optionalangers?: numberOptionalbookmarks?: numberOptionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollows?: numberOptionalhahas?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalloves?: numberOptionalnegative_feedback?: numberOptionaloutbound_clicks?: numberOptionalpage_likes?: numberOptionalpin_clicks?: numberOptionalplayback_0_count?: numberOptionalplayback_100_count?: numberOptionalplayback_25_count?: numberOptionalplayback_50_count?: numberOptionalplayback_75_count?: numberOptionalprofile_activity?: numberOptionalprofile_visits?: numberOptionalquotes?: numberOptionalreach?: numberOptionalreactions?: numberOptionalreactions_by_emoji?: { [key: string]: number }Optionalreplys?: numberOptionalretwets?: numberOptionalsaved?: numberOptionalsaves?: numberOptionalshare?: numberOptionalshareMentions?: numberOptionalshares?: numberOptionalsorrys?: numberOptionalurl_link_clicks?: numberOptionaluser_profile_clicks?: numberOptionalvideo_views?: numberOptionalviews?: numberOptionalwows?: number
Optionalstats_updated_date?: stringFormat: date-time
Optionaltext?: stringOptionaltitle?: stringOptionalurl?: stringOptionalvisibility?: "public" | "unlisted" | "private"
PublicationsPublicationRetry: {
max_retries: number;
publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
};
}max_retries: number
publication: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}_id: string
Optionalai_generated?: { image: boolean; text: boolean }image: boolean
text: boolean
creation_date: string
Format: date-time
Optionaldestination?: { id?: string; name?: string; section_id?: string; section_name?: string }Optionalid?: stringDescription
The board id. Always a string, never a number: Pinterest's ids are long integers, so a client that sends one as a JSON number has already lost digits to rounding before the request arrives. That is refused —
publication_errors[].code = 987withdata.reason = "invalid_id"— rather than published to some other board. Sending the board's name instead of its id fails the same way, which is the likeliest first mistake of an integration.Optionalname?: stringOptionalsection_id?: stringOptionalsection_name?: string
Optionalengagement_base?: "reach" | "impressions" | "followers"Optionalexternal_identifier?: stringOptionalextra_data?: { [key: string]: unknown }Description
What one network needs to remember about this publication and that has no common field. Absent on a publication whose network needs nothing, which is almost all of them.
Today only `telegram` writes here, and only `telegram_message_ids`: the ids of every message an album turned into, because deleting the album means deleting all of them.files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[]id_account:
| string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: boolean } & {
[key: string]: unknown;
};
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
}Optionalid_integration?: stringid_organization: string
Optionallink?: stringDescription
The destination link: where the publication takes whoever clicks it. Not to be confused with
url, which is the link to the publication on the network and only exists once it is published.Only the networks that answer `link: true` in `GET /social_capabilities` carry it — today `pinterest` alone, where a pin has a `link` field of its own and sending traffic somewhere is the whole point of publishing there. Putting the URL inside `text` instead leaves it visible and unclickable. **On every other network the field is deleted on save**, like `destination`.Optionalmade_for_kids?: booleanOptionalmetrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
Optionalname?: stringOptionalnext_stats_update?: stringFormat: date-time
Optionalpending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
}Optionaldata?: { [key: string]: unknown }Optionaldeadline?: stringFormat: date-time
Optionalnext_check?: stringFormat: date-time
Optionaltemp_keys?: string[]
publication_errors: { code: number; data?: { [key: string]: unknown }; message: string }[]
Description
Why the publication failed, one entry per problem. It is an array, and it is empty on a publication that has not failed.
For a scheduled X (Twitter) publication that runs out of credits at publish time, `code` is 940 and `data` is `{ used, limit }`; the publication stays in state `withErrors`. No webhook announces it: read the publication to find out. On Instagram, two codes tell you whether a retry makes sense. **998**: Meta rejected the media while processing it (a codec, a duration, a URL it could not download). `data` carries `container_id`, `status_code` and, when Meta gives one, its reason in `status`. Retrying the same file fails the same way: change it first. **999**: Meta had not finished processing the media 10 minutes after it was sent. `data` carries `container_ids` and `minutes`. The file is not the problem, and a retry usually works.publication_type: "profile" | "page" | "group" | "reels" | "stories" | "message"
Optionalpublication_warnings?: { code: number; data?: { [key: string]: unknown }; message: string }[]Description
What still has to be done by hand on the network for a publication that DID go out. Same shape as
publication_errors, and an empty array when there is nothing to do.It is a separate field because these are not failures: the publication stays in state `sended` and must **not** be retried, because retrying would publish it twice. Like `publication_errors`, it belongs to the last attempt. Today there is one code. **2400** (YouTube): YouTube accepted the upload but did not make the video public, so YouTube Studio shows it as a draft or private until someone sets its audience and visibility there. The upload does not fail when this happens; PlanVortex reads the video back right after uploading it to find out. `data` carries `requested_privacy_status`, `privacy_status` (what YouTube actually left), `upload_status`, `made_for_kids` and `studio_url`, the YouTube Studio page where it is finished.Optionalpublish_date?: stringFormat: date-time
Optionalreply_control?: "everyone" | "accounts_you_follow" | "mentioned_only" | "followers_only"Description
Who can reply to the publication, on the networks that answer
reply_control: trueinGET /social_capabilities(todaythreads). Absent means the network's default, which is anyone. It is set when the publication goes out and cannot be changed afterwards.**On every other network the field is deleted on save**, like `link`.retries: number
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"state: "ready" | "withErrors" | "sended" | "draft" | "publishing"
Description
draftis never sent;readyis scheduled;publishingis in the network's hands right now;sendedwent out;withErrorsfailed and carries the reason inpublication_errors.`publishing` usually lasts a few seconds, but it can last **up to 10 minutes** when the network is still processing a video (today, Instagram). Then `pending_publish` is present: wait and read the publication again, do not retry it.Optionalstatistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
}Optionalangers?: numberOptionalbookmarks?: numberOptionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollows?: numberOptionalhahas?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalloves?: numberOptionalnegative_feedback?: numberOptionaloutbound_clicks?: numberOptionalpage_likes?: numberOptionalpin_clicks?: numberOptionalplayback_0_count?: numberOptionalplayback_100_count?: numberOptionalplayback_25_count?: numberOptionalplayback_50_count?: numberOptionalplayback_75_count?: numberOptionalprofile_activity?: numberOptionalprofile_visits?: numberOptionalquotes?: numberOptionalreach?: numberOptionalreactions?: numberOptionalreactions_by_emoji?: { [key: string]: number }Optionalreplys?: numberOptionalretwets?: numberOptionalsaved?: numberOptionalsaves?: numberOptionalshare?: numberOptionalshareMentions?: numberOptionalshares?: numberOptionalsorrys?: numberOptionalurl_link_clicks?: numberOptionaluser_profile_clicks?: numberOptionalvideo_views?: numberOptionalviews?: numberOptionalwows?: number
Optionalstats_updated_date?: stringFormat: date-time
Optionaltext?: stringOptionaltitle?: stringOptionalurl?: stringOptionalvisibility?: "public" | "unlisted" | "private"
PublicationsPublicationsStatsList: {
metric?: string;
publications?: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: (...)
| (...)
| (...) } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}[];
range?: {
from_date?: string;
previous_from_date?: string;
previous_to_date?: string;
to_date?: string;
};
summary?: {
by_network?: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: string;
}[];
previous_total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
};
total?: number;
}Optionalmetric?: stringOptionalpublications?: {
_id: string;
ai_generated?: { image: boolean; text: boolean };
creation_date: string;
destination?: {
id?: string;
name?: string;
section_id?: string;
section_name?: string;
};
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
extra_data?: { [key: string]: unknown };
files: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
id_account: | string
| {
_id: string;
creation_date: string;
error_code: number;
extra_data?: { is_personal_profile?: (...)
| (...)
| (...) } & { [key: string]: unknown };
followers_count?: number;
id_client: string;
id_organization: string;
image?: string;
name: string;
next_comments_update?: string;
next_stats_update?: string;
private_message_link?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
username?: string;
};
id_integration?: string;
id_organization: string;
link?: string;
made_for_kids?: boolean;
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
name?: string;
next_stats_update?: string;
pending_publish?: {
data?: { [key: string]: unknown };
deadline?: string;
next_check?: string;
temp_keys?: string[];
};
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publication_warnings?: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publish_date?: string;
reply_control?: | "everyone"
| "accounts_you_follow"
| "mentioned_only"
| "followers_only";
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
state: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
text?: string;
title?: string;
url?: string;
visibility?: "public"
| "unlisted"
| "private";
}[]Optionalrange?: {
from_date?: string;
previous_from_date?: string;
previous_to_date?: string;
to_date?: string;
}Optionalfrom_date?: stringFormat: date-time
Optionalprevious_from_date?: stringFormat: date-time
Optionalprevious_to_date?: stringFormat: date-time
Optionalto_date?: stringFormat: date-time
Optionalsummary?: {
by_network?: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: string;
}[];
previous_total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
}Optionalby_network?: {
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
publications?: number;
social_network?: string;
}[]Optionalprevious_total?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
Optionaltotal?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
Optionaltotal?: number
PublicationsPublicationStatsHistory: {
engagement_base?: "reach" | "impressions" | "followers";
id_publication: string;
latest?: {
collected_date: string;
engagement_base?: "reach" | "impressions" | "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
raw?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
};
metrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
next_stats_update?: string;
publish_date?: string;
series: {
collected_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
}[];
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
stats_updated_date?: string;
}Optionalengagement_base?: "reach" | "impressions" | "followers"id_publication: string
Optionallatest?: {
collected_date: string;
engagement_base?: "reach" | "impressions" | "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
raw?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
};
}collected_date: string
Format: date-time
Optionalengagement_base?: "reach" | "impressions" | "followers"metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
Optionalraw?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
}Optionalangers?: numberOptionalbookmarks?: numberOptionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollows?: numberOptionalhahas?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalloves?: numberOptionalnegative_feedback?: numberOptionaloutbound_clicks?: numberOptionalpage_likes?: numberOptionalpin_clicks?: numberOptionalplayback_0_count?: numberOptionalplayback_100_count?: numberOptionalplayback_25_count?: numberOptionalplayback_50_count?: numberOptionalplayback_75_count?: numberOptionalprofile_activity?: numberOptionalprofile_visits?: numberOptionalquotes?: numberOptionalreach?: numberOptionalreactions?: numberOptionalreactions_by_emoji?: { [key: string]: number }Optionalreplys?: numberOptionalretwets?: numberOptionalsaved?: numberOptionalsaves?: numberOptionalshare?: numberOptionalshareMentions?: numberOptionalshares?: numberOptionalsorrys?: numberOptionalurl_link_clicks?: numberOptionaluser_profile_clicks?: numberOptionalvideo_views?: numberOptionalviews?: numberOptionalwows?: number
Optionalmetrics?: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
Optionalnext_stats_update?: stringFormat: date-time
Optionalpublish_date?: stringFormat: date-time
series: {
collected_date: string;
engagement_base?: "reach" | "impressions" | "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
}[]social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"Optionalstatistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
}Optionalangers?: numberOptionalbookmarks?: numberOptionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollows?: numberOptionalhahas?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalloves?: numberOptionalnegative_feedback?: numberOptionaloutbound_clicks?: numberOptionalpage_likes?: numberOptionalpin_clicks?: numberOptionalplayback_0_count?: numberOptionalplayback_100_count?: numberOptionalplayback_25_count?: numberOptionalplayback_50_count?: numberOptionalplayback_75_count?: numberOptionalprofile_activity?: numberOptionalprofile_visits?: numberOptionalquotes?: numberOptionalreach?: numberOptionalreactions?: numberOptionalreactions_by_emoji?: { [key: string]: number }Optionalreplys?: numberOptionalretwets?: numberOptionalsaved?: numberOptionalsaves?: numberOptionalshare?: numberOptionalshareMentions?: numberOptionalshares?: numberOptionalsorrys?: numberOptionalurl_link_clicks?: numberOptionaluser_profile_clicks?: numberOptionalvideo_views?: numberOptionalviews?: numberOptionalwows?: number
Optionalstats_updated_date?: stringFormat: date-time
PublicationsPublicationStatsPoint: {
collected_date: string;
engagement_base?: "reach" | "impressions" | "followers";
metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
};
}collected_date: string
Format: date-time
Optionalengagement_base?: "reach" | "impressions" | "followers"metrics: {
clicks?: number;
comments?: number;
engagement?: number;
followers?: number;
followers_gained?: number;
impressions?: number;
likes?: number;
profile_views?: number;
reach?: number;
saves?: number;
shares?: number;
video_views?: number;
}Optionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollowers?: numberOptionalfollowers_gained?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalprofile_views?: numberOptionalreach?: numberOptionalsaves?: numberOptionalshares?: numberOptionalvideo_views?: number
PublicationStats: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
outbound_clicks?: number;
page_likes?: number;
pin_clicks?: number;
playback_0_count?: number;
playback_100_count?: number;
playback_25_count?: number;
playback_50_count?: number;
playback_75_count?: number;
profile_activity?: number;
profile_visits?: number;
quotes?: number;
reach?: number;
reactions?: number;
reactions_by_emoji?: { [key: string]: number };
replys?: number;
retwets?: number;
saved?: number;
saves?: number;
share?: number;
shareMentions?: number;
shares?: number;
sorrys?: number;
url_link_clicks?: number;
user_profile_clicks?: number;
video_views?: number;
views?: number;
wows?: number;
}Description
Raw, per-network metrics for a publication. Only the fields that belong to the publication's own social network are returned.
**An absent field is not a zero.** A field is present only when the network actually reported it; `0` means the network measured zero. This matters most on X (Twitter), where metrics are split into groups with different access levels: `public_metrics` (likes, replys, retwets, quotes, bookmarks, impressions) is always available, while clicks, the pre-computed `engagement` and the video playback quartiles come from X's non-public metrics — only for your own posts, within 30 days of publishing, and only if the app is entitled to them. When they are unavailable they are omitted rather than returned as `0`. Do not default missing fields to zero when displaying them. On `discord` there are only two: `likes` (the reactions on the message) and `comments` (the messages in its thread). There is no impressions figure anywhere in Discord's API, so engagement is computed over the server's member count. On `bluesky` there are no impressions and no reach either — only the public counters — so engagement is computed over followers. On `threads` there are six, and the one that matters is `views`: it is the only one of the four newest networks with something like impressions, so its engagement rate is computed over a real base and not over followers. Sharing arrives split in three — `reposts`, `quotes` and `shares` (outside Threads) — and the three are added into one figure, the same criterion as on X; the breakdown stays in `raw`. A reply is what every other network calls a comment. On `telegram` there are two as well, and **neither of them is asked for**: the Bot API has no method that returns a message's metrics, so `reactions` arrives on its own through the bot and `comments` is counted in PlanVortex's own inbox. There are no impressions, no reach, no views and no forwards to be had anywhere in it, so engagement is computed over followers. On `slack` there is exactly **one**, `reactions`, and the other absences are the informative part: the Web API publishes no impressions, no reach, no views and no clicks for a message, so those keys are missing rather than zero. There is no `comments` either — Slack threads are not read at all (`comments` is `false` in `GET /social_capabilities`). Engagement is computed over the channel's members. On `pinterest` there are seven, and three of them exist nowhere else: `saves` — the gesture the whole network is built on —, `outbound_clicks` (clicks that left the pin towards its `link`, which is the one normalised as the common `clicks`) and `pin_clicks` (clicks that opened the pin inside Pinterest, with no common equivalent). `impressions` is real here, so the engagement rate is computed over it and not over followers. `video_views` only exists on a video pin. And `comments` is the odd one: Pinterest **counts** them and offers no way to read them, so the number is reported while `comments` is `false` in `GET /social_capabilities` — this network has no comment inbox, and it is not a gap waiting to be filled.Optionalangers?: numberOptionalbookmarks?: numberOptionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollows?: numberOptionalhahas?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalloves?: numberOptionalnegative_feedback?: numberOptionaloutbound_clicks?: numberOptionalpage_likes?: numberOptionalpin_clicks?: numberOptionalplayback_0_count?: numberOptionalplayback_100_count?: numberOptionalplayback_25_count?: numberOptionalplayback_50_count?: numberOptionalplayback_75_count?: numberOptionalprofile_activity?: numberOptionalprofile_visits?: numberOptionalquotes?: numberOptionalreach?: numberOptionalreactions?: numberOptionalreactions_by_emoji?: { [key: string]: number }Optionalreplys?: numberOptionalretwets?: numberOptionalsaved?: numberOptionalsaves?: numberOptionalshare?: numberOptionalshareMentions?: numberOptionalshares?: numberOptionalsorrys?: numberOptionalurl_link_clicks?: numberOptionaluser_profile_clicks?: numberOptionalvideo_views?: numberOptionalviews?: numberOptionalwows?: number
SocialCredentials: {
application_name?: string;
client_id?: string;
has_bot_token?: boolean;
has_client_secret?: boolean;
verified_date?: string;
}Optionalapplication_name?: stringOptionalclient_id?: stringOptionalhas_bot_token?: booleanOptionalhas_client_secret?: booleanOptionalverified_date?: stringFormat: date-time
SocialIdentifier: {
_id: string;
external_identifier?: string;
last_send_date?: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email";
}_id: string
Optionalexternal_identifier?: stringOptionallast_send_date?: stringFormat: date-time
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "email"
SocialNetwork:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest"StatsSettings: { auto_refresh_twitter: boolean }
auto_refresh_twitter: boolean
Success: { success: boolean }
Upload: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}_id: string
Optionalai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string }generated_at: string
Format: date-time
Optionalid_ai_plan?: stringmodel: string
provider: string
Optionalcover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...Optionalcover_offset?: numbercreation_date: string
Format: date-time
file_externals: {
external_identifier: string;
external_url: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[]file_format: "mp4" | "jpeg" | "gif" | "png" | "jpg"
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
}allowed_social_networks: string[]
aspect_ratio: { text: string; value: number }
text: string
value: number
duration: number
height: number
size_in_bytes: number
width: number
file_type: "video" | "image"
id_organization: string
is_temporal: boolean
name: string
public_path: string
Format: uri
UploadsUploadList: {
total: number;
uploads: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}[];
}UploadsUploadOne: {
upload: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
};
}upload: {
_id: string;
ai_generated?: {
generated_at: string;
id_ai_plan?: string;
model: string;
provider: string;
};
cover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...;
cover_offset?: number;
creation_date: string;
file_externals: {
external_identifier: string;
external_url: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[];
file_format: "mp4"
| "jpeg"
| "gif"
| "png"
| "jpg";
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
};
file_type: "video"
| "image";
id_organization: string;
is_temporal: boolean;
name: string;
public_path: string;
}_id: string
Optionalai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string }generated_at: string
Format: date-time
Optionalid_ai_plan?: stringmodel: string
provider: string
Optionalcover_image?: { _id: string; ai_generated?: { generated_at: string; id_ai_plan?: string; model: string; provider: string; }; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | ... 12 more ... | "pinterest"; }[]; ... 6 m...Optionalcover_offset?: numbercreation_date: string
Format: date-time
file_externals: {
external_identifier: string;
external_url: string;
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"
| "telegram"
| "threads"
| "slack"
| "pinterest";
}[]file_format: "mp4" | "jpeg" | "gif" | "png" | "jpg"
file_properties: {
allowed_social_networks: string[];
aspect_ratio: { text: string; value: number };
duration: number;
height: number;
size_in_bytes: number;
width: number;
}allowed_social_networks: string[]
aspect_ratio: { text: string; value: number }
text: string
value: number
duration: number
height: number
size_in_bytes: number
width: number
file_type: "video" | "image"
id_organization: string
is_temporal: boolean
name: string
public_path: string
Format: uri
Description
Start of the range, ISO 8601. Defaults to 30 days before
to_date. A range longer than 366 days answers error 1003.