Interface OpenApiComponents
interface OpenApiComponents {
headers: never;
parameters: {
AiPlansidAiPlan: string;
AiPlansidClient: string;
AiPlansidOrganization: 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;
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";
username?: string;
};
AccountsAccountList: {
accounts: {
_id: string;
creation_date: string;
error_code: number;
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";
username?: string;
}[];
total: number;
};
AccountsAccountOne: {
account: {
_id: string;
creation_date: string;
error_code: number;
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";
username?: string;
};
};
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: {
app_id?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
type: "redirect"
| "meta_embedded_signup";
};
AccountsSocialLinksList: {
links: {
authorization: {
app_id?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
type: "redirect"
| "meta_embedded_signup";
};
link: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
}[];
};
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;
};
AiPlansAiPlan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
AiPlansAiPlanCostEstimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
AiPlansAiPlanCreateRequest: {
accounts: string[];
options?: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
prompt: string;
};
AiPlansAiPlanCreateResponse: {
ai_plan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
estimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
estimated_cost: number;
};
AiPlansAiPlanList: {
ai_plans: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
}[];
total: number;
};
AiPlansAiPlanOne: {
ai_plan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
};
AiPlansAiPlanOptions: {
allow_images: boolean;
gallery_uploads: string[];
language: 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;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: 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[] };
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
name: string;
};
ClientsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
}[];
};
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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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";
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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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;
messages: boolean;
persistent_menu: boolean;
products: boolean;
publications: 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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
};
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";
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_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_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";
username?: string;
}[];
publications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[];
total_drafts?: number;
upcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[];
};
messages?: { unread: number };
plan_use?: {
actual_asigned: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
};
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";
}[];
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;
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";
}[];
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";
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";
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;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
};
DashboardPublicationsSummary: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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";
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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";
};
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: {
auto_publish?: boolean;
id_accounts?: string[];
import_image?: boolean;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
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";
};
IntegrationsIntegrationProvider: {
accepted_formats: string[];
config_fields: {
default?: unknown;
name: string;
options?: string[];
required?: boolean;
type: "boolean"
| "text"
| "url"
| "accounts"
| "textarea"
| "select";
}[];
content_feed: boolean;
file_import: boolean;
provider: "google_drive"
| "rss";
requires_oauth: boolean;
};
IntegrationsIntegrationProviderName: "google_drive"
| "rss";
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;
};
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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: {
message_options?: {
files: (
| string
| {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
OrganizationsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
name: string;
};
OrganizationsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
creation_date: string;
engagement_base?: "reach" | "impressions" | "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
PublicationsPublicationInput: {
files?: string[];
name?: string;
publication_type?: "profile"
| "page"
| "group"
| "reels"
| "stories";
publish_date?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "bluesky"
| "discord";
state?: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
text?: string;
title?: string;
};
PublicationsPublicationList: {
publications: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}[];
total: number;
};
PublicationsPublicationOne: {
publication: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
};
PublicationsPublicationRetry: {
max_retries: number;
publication: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
};
PublicationsPublicationsStatsList: {
metric?: string;
publications?: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}[];
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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";
StatsSettings: { auto_refresh_twitter: boolean };
Success: { success: boolean };
Upload: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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: {
AiPlansidAiPlan: string;
AiPlansidClient: string;
AiPlansidOrganization: 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;
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";
username?: string;
};
AccountsAccountList: {
accounts: {
_id: string;
creation_date: string;
error_code: number;
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";
username?: string;
}[];
total: number;
};
AccountsAccountOne: {
account: {
_id: string;
creation_date: string;
error_code: number;
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";
username?: string;
};
};
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: {
app_id?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
type: "redirect"
| "meta_embedded_signup";
};
AccountsSocialLinksList: {
links: {
authorization: {
app_id?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
type: "redirect"
| "meta_embedded_signup";
};
link: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
}[];
};
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;
};
AiPlansAiPlan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
AiPlansAiPlanCostEstimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
AiPlansAiPlanCreateRequest: {
accounts: string[];
options?: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
prompt: string;
};
AiPlansAiPlanCreateResponse: {
ai_plan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
estimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
estimated_cost: number;
};
AiPlansAiPlanList: {
ai_plans: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
}[];
total: number;
};
AiPlansAiPlanOne: {
ai_plan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
};
AiPlansAiPlanOptions: {
allow_images: boolean;
gallery_uploads: string[];
language: 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;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: 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[] };
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
name: string;
};
ClientsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
}[];
};
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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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";
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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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;
messages: boolean;
persistent_menu: boolean;
products: boolean;
publications: 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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
};
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";
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_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_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";
username?: string;
}[];
publications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[];
total_drafts?: number;
upcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[];
};
messages?: { unread: number };
plan_use?: {
actual_asigned: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
};
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";
}[];
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;
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";
}[];
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";
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";
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;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
};
DashboardPublicationsSummary: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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";
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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";
};
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: {
auto_publish?: boolean;
id_accounts?: string[];
import_image?: boolean;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
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";
};
IntegrationsIntegrationProvider: {
accepted_formats: string[];
config_fields: {
default?: unknown;
name: string;
options?: string[];
required?: boolean;
type: "boolean"
| "text"
| "url"
| "accounts"
| "textarea"
| "select";
}[];
content_feed: boolean;
file_import: boolean;
provider: "google_drive"
| "rss";
requires_oauth: boolean;
};
IntegrationsIntegrationProviderName: "google_drive"
| "rss";
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;
};
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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: {
message_options?: {
files: (
| string
| {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
OrganizationsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
name: string;
};
OrganizationsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
creation_date: string;
engagement_base?: "reach" | "impressions" | "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
PublicationsPublicationInput: {
files?: string[];
name?: string;
publication_type?: "profile"
| "page"
| "group"
| "reels"
| "stories";
publish_date?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "bluesky"
| "discord";
state?: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
text?: string;
title?: string;
};
PublicationsPublicationList: {
publications: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}[];
total: number;
};
PublicationsPublicationOne: {
publication: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
};
PublicationsPublicationRetry: {
max_retries: number;
publication: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
};
PublicationsPublicationsStatsList: {
metric?: string;
publications?: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}[];
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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";
StatsSettings: { auto_refresh_twitter: boolean };
Success: { success: boolean };
Upload: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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: {
AiPlansidAiPlan: string;
AiPlansidClient: string;
AiPlansidOrganization: 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;
}
AiPlansidAiPlan: string;
AiPlansidClient: string;
AiPlansidOrganization: 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
AiPlansidAiPlan: string
AiPlansidClient: string
AiPlansidOrganization: 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. | | `1101` | Invalid organization. | | `1501` | The comment's account could not be resolved. |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;
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";
username?: string;
};
AccountsAccountList: {
accounts: {
_id: string;
creation_date: string;
error_code: number;
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";
username?: string;
}[];
total: number;
};
AccountsAccountOne: {
account: {
_id: string;
creation_date: string;
error_code: number;
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";
username?: string;
};
};
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: {
app_id?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
type: "redirect"
| "meta_embedded_signup";
};
AccountsSocialLinksList: {
links: {
authorization: {
app_id?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
type: "redirect"
| "meta_embedded_signup";
};
link: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
}[];
};
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;
};
AiPlansAiPlan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
AiPlansAiPlanCostEstimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
AiPlansAiPlanCreateRequest: {
accounts: string[];
options?: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
prompt: string;
};
AiPlansAiPlanCreateResponse: {
ai_plan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
estimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
estimated_cost: number;
};
AiPlansAiPlanList: {
ai_plans: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
}[];
total: number;
};
AiPlansAiPlanOne: {
ai_plan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
};
AiPlansAiPlanOptions: {
allow_images: boolean;
gallery_uploads: string[];
language: 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;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: 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[] };
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
name: string;
};
ClientsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
}[];
};
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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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";
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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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;
messages: boolean;
persistent_menu: boolean;
products: boolean;
publications: 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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
};
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";
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_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_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";
username?: string;
}[];
publications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[];
total_drafts?: number;
upcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[];
};
messages?: { unread: number };
plan_use?: {
actual_asigned: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
};
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";
}[];
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;
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";
}[];
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";
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";
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;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
};
DashboardPublicationsSummary: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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";
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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";
};
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: {
auto_publish?: boolean;
id_accounts?: string[];
import_image?: boolean;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
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";
};
IntegrationsIntegrationProvider: {
accepted_formats: string[];
config_fields: {
default?: unknown;
name: string;
options?: string[];
required?: boolean;
type: "boolean"
| "text"
| "url"
| "accounts"
| "textarea"
| "select";
}[];
content_feed: boolean;
file_import: boolean;
provider: "google_drive"
| "rss";
requires_oauth: boolean;
};
IntegrationsIntegrationProviderName: "google_drive"
| "rss";
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;
};
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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: {
message_options?: {
files: (
| string
| {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
OrganizationsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
name: string;
};
OrganizationsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
creation_date: string;
engagement_base?: "reach" | "impressions" | "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
PublicationsPublicationInput: {
files?: string[];
name?: string;
publication_type?: "profile"
| "page"
| "group"
| "reels"
| "stories";
publish_date?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "bluesky"
| "discord";
state?: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
text?: string;
title?: string;
};
PublicationsPublicationList: {
publications: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}[];
total: number;
};
PublicationsPublicationOne: {
publication: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
};
PublicationsPublicationRetry: {
max_retries: number;
publication: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
};
PublicationsPublicationsStatsList: {
metric?: string;
publications?: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}[];
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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";
StatsSettings: { auto_refresh_twitter: boolean };
Success: { success: boolean };
Upload: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
AccountsAccountList: {
accounts: {
_id: string;
creation_date: string;
error_code: number;
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";
username?: string;
}[];
total: number;
};
AccountsAccountOne: {
account: {
_id: string;
creation_date: string;
error_code: number;
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";
username?: string;
};
};
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: {
app_id?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
type: "redirect"
| "meta_embedded_signup";
};
AccountsSocialLinksList: {
links: {
authorization: {
app_id?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
type: "redirect"
| "meta_embedded_signup";
};
link: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
}[];
};
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;
};
AiPlansAiPlan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
AiPlansAiPlanCostEstimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
AiPlansAiPlanCreateRequest: {
accounts: string[];
options?: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
prompt: string;
};
AiPlansAiPlanCreateResponse: {
ai_plan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
estimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
};
estimated_cost: number;
};
AiPlansAiPlanList: {
ai_plans: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
}[];
total: number;
};
AiPlansAiPlanOne: {
ai_plan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
};
AiPlansAiPlanOptions: {
allow_images: boolean;
gallery_uploads: string[];
language: 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;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: 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[] };
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
name: string;
};
ClientsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
}[];
};
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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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";
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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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;
messages: boolean;
persistent_menu: boolean;
products: boolean;
publications: 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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
};
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";
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_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_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";
username?: string;
}[];
publications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[];
total_drafts?: number;
upcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[];
};
messages?: { unread: number };
plan_use?: {
actual_asigned: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
};
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";
}[];
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;
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";
}[];
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";
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";
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;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
};
DashboardPublicationsSummary: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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";
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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";
};
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: {
auto_publish?: boolean;
id_accounts?: string[];
import_image?: boolean;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
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";
};
IntegrationsIntegrationProvider: {
accepted_formats: string[];
config_fields: {
default?: unknown;
name: string;
options?: string[];
required?: boolean;
type: "boolean"
| "text"
| "url"
| "accounts"
| "textarea"
| "select";
}[];
content_feed: boolean;
file_import: boolean;
provider: "google_drive"
| "rss";
requires_oauth: boolean;
};
IntegrationsIntegrationProviderName: "google_drive"
| "rss";
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;
};
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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: {
message_options?: {
files: (
| string
| {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
OrganizationsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
name: string;
};
OrganizationsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
creation_date: string;
engagement_base?: "reach" | "impressions" | "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
PublicationsPublicationInput: {
files?: string[];
name?: string;
publication_type?: "profile"
| "page"
| "group"
| "reels"
| "stories";
publish_date?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "bluesky"
| "discord";
state?: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
text?: string;
title?: string;
};
PublicationsPublicationList: {
publications: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}[];
total: number;
};
PublicationsPublicationOne: {
publication: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
};
PublicationsPublicationRetry: {
max_retries: number;
publication: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
};
PublicationsPublicationsStatsList: {
metric?: string;
publications?: {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}[];
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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";
StatsSettings: { auto_refresh_twitter: boolean };
Success: { success: boolean };
Upload: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
}Description
A social account connected to an organization.
On `discord` an account is a **channel**, not a profile: publishing to two channels of the same server costs two accounts of the plan. `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._id: string
creation_date: string
Format: date-time
error_code: number
Optionalfollowers_count?: numberid_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"Optionalusername?: string
AccountsAccountList: {
accounts: {
_id: string;
creation_date: string;
error_code: number;
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";
username?: string;
}[];
total: number;
}AccountsAccountOne: {
account: {
_id: string;
creation_date: string;
error_code: number;
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";
username?: string;
};
}account: {
_id: string;
creation_date: string;
error_code: number;
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";
username?: string;
}_id: string
creation_date: string
Format: date-time
error_code: number
Optionalfollowers_count?: numberid_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"Optionalusername?: string
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: {
app_id?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
type: "redirect" | "meta_embedded_signup";
}Description
How an account of this network is authorized, which is not always "send the user to this URL".
Nine of the ten networks are `redirect`: open `link` and the network sends the person back to PlanVortex with a code. **WhatsApp is not.** 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. Branch on `authorization.type`, never on whether `link` is empty.Optionalapp_id?: stringOptionalconfig_id?: stringOptionalfeature_type?: stringOptionalgraph_version?: stringOptionalsession_info_version?: stringtype: "redirect" | "meta_embedded_signup"
AccountsSocialLinksList: {
links: {
authorization: {
app_id?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
type: "redirect" | "meta_embedded_signup";
};
link: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
}[];
}links: {
authorization: {
app_id?: string;
config_id?: string;
feature_type?: string;
graph_version?: string;
session_info_version?: string;
type: "redirect" | "meta_embedded_signup";
};
link: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
}[]
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
AiPlansAiPlan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
}_id: string
accounts: string[]
attempts: number
creation_date: string
Format: date-time
credits_spent: number
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;
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
Optionalmax_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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[]state: "pending" | "generating" | "generated" | "validated" | "failed" | "cancelled"
AiPlansAiPlanCostEstimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
}available_credits: number
base_cost: number
estimated_cost: number
images_target: number
texts_target: number
AiPlansAiPlanCreateRequest: {
accounts: string[];
options?: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: string;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
};
prompt: string;
}accounts: string[]
Optionaloptions?: {
allow_images?: boolean;
gallery_uploads?: string[];
language?: 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[]Optionallanguage?: stringOptionalmax_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?: booleanOptionaltimezone?: stringOptionaltone?: stringOptionaluse_organization_context?: booleanOptionalweek_start?: stringFormat: date-time
prompt: string
AiPlansAiPlanCreateResponse: {
ai_plan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
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[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
}_id: string
accounts: string[]
attempts: number
creation_date: string
Format: date-time
credits_spent: number
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;
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
Optionalmax_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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[]state: "pending" | "generating" | "generated" | "validated" | "failed" | "cancelled"
estimate: {
available_credits: number;
base_cost: number;
estimated_cost: number;
images_target: number;
texts_target: number;
}available_credits: number
base_cost: number
estimated_cost: number
images_target: number
texts_target: number
estimated_cost: number
AiPlansAiPlanList: {
ai_plans: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: ...]: ... };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
}[];
total: number;
}AiPlansAiPlanOne: {
ai_plan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
};
}ai_plan: {
_id: string;
accounts: string[];
attempts: number;
creation_date: string;
credits_spent: number;
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;
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[];
state: | "pending"
| "generating"
| "generated"
| "validated"
| "failed"
| "cancelled";
}_id: string
accounts: string[]
attempts: number
creation_date: string
Format: date-time
credits_spent: number
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;
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
Optionalmax_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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}
)[]state: "pending" | "generating" | "generated" | "validated" | "failed" | "cancelled"
AiPlansAiPlanOptions: {
allow_images: boolean;
gallery_uploads: string[];
language: 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
Optionalmax_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;
max_images?: number;
publish_days?: number[];
shared?: boolean;
timezone?: string;
tone?: string;
use_organization_context?: boolean;
week_start?: string;
}Optionalallow_images?: booleanOptionalgallery_uploads?: string[]Optionallanguage?: stringOptionalmax_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?: booleanOptionaltimezone?: stringOptionaltone?: stringOptionaluse_organization_context?: booleanOptionalweek_start?: stringFormat: date-time
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` and `integration_error`. The payload is documented in the `comments` specification. 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
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[]
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 }
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";
}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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
plan_identifier: "basic" | "free" | "pro" | "custom"
Optionalrequire_action?: booleanstatus: string
Optionalstripe_customer_id?: string
Optionalactual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
plan_identifier: "basic"
| "free"
| "pro"
| "custom";
require_action?: boolean;
status: string;
stripe_customer_id?: string;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
actual_plan: {
current_period_end?: string;
current_period_start?: string;
enabled: boolean;
isEnabled: boolean;
plan_data: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
plan_identifier: "basic" | "free" | "pro" | "custom"
Optionalrequire_action?: booleanstatus: string
Optionalstripe_customer_id?: string
Optionalactual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
name: string;
}Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
name: string
ClientsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}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?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
Optionalactual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
stats_settings?: { auto_refresh_twitter: boolean };
}Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
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;
}[];
}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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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
hidden: boolean
id_account:
| string
| {
_id: string;
creation_date: string;
error_code: number;
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";
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}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"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"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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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;
messages: boolean;
persistent_menu: boolean;
products: boolean;
publications: 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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
}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;
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";
username?: string;
};
id_organization: string;
id_publication?: | string
| {
_id: string;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
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";
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
hidden: boolean
id_account:
| string
| {
_id: string;
creation_date: string;
error_code: number;
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";
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;
creation_date: string;
engagement_base?: "reach"
| "impressions"
| "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}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"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. - `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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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;
whatsappInteractive?: { [key: string]: unknown };
}files: (
| string
| {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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?: stringOptionalwhatsappInteractive?: { [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"
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";
username?: string;
}_id: string
error_code: number
Optionalimage?: stringname: string
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"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_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_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";
username?: string;
}[];
publications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[];
total_drafts?: number;
upcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[];
};
messages?: { unread: number };
plan_use?: {
actual_asigned: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
};
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";
}[];
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;
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";
}[];
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";
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";
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_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_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";
username?: string;
}[];
publications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[];
total_drafts?: number;
upcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...)
| (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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";
username?: string;
}[]Optionalpublications_with_errors?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...) | (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[]Optionaltotal_drafts?: numberOptionalupcoming_publications?: {
_id: string;
creation_date?: string;
name?: string;
publication_errors?: {
code: number;
data?: (...) | (...);
message: string;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}[]
Optionalmessages?: { unread: number }Optionalplan_use?: {
actual_asigned: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
}actual_asigned: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
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";
}[];
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;
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";
}[];
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";
}[]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;
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";
}[]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";
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";
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;
}[];
publish_date?: string;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
text?: string;
}_id: string
Optionalcreation_date?: stringFormat: date-time
Optionalname?: stringOptionalpublication_errors?: { code: number; data?: { [key: string]: unknown }; message: string }[]Optionalpublish_date?: stringFormat: date-time
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
}actual_asigned: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
actual_use: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
limits: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
DashboardPublicationsSummary: {
by_day: { day?: string; state?: string; total?: number }[];
by_network: {
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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";
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";
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";
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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";
}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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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"
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-544 auth, tokens and client apps · 601-612 user · 700-715 social accounts · 800-810 files · 900-960 publications · 1000-1003 general · 1100-1111 organizations · 1200-1207 roles · 1300-1307 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.
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: {
auto_publish?: boolean;
id_accounts?: string[];
import_image?: boolean;
last_checked?: string;
publication_type?: string;
seen_guids?: string[];
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";
}_id: string
config: {
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
connected: boolean
creation_date: string
Format: date-time
enabled: boolean
Optionalerror_code?: null | numberOptionalexternal_identifier?: stringid_client: string
id_organization: string
Optionallast_used_date?: stringFormat: date-time
name: string
provider: "google_drive" | "rss"
IntegrationsIntegrationProvider: {
accepted_formats: string[];
config_fields: {
default?: unknown;
name: string;
options?: string[];
required?: boolean;
type: "boolean" | "text" | "url" | "accounts" | "textarea" | "select";
}[];
content_feed: boolean;
file_import: boolean;
provider: "google_drive"
| "rss";
requires_oauth: boolean;
}accepted_formats: string[]
config_fields: {
default?: unknown;
name: string;
options?: string[];
required?: boolean;
type: "boolean" | "text" | "url" | "accounts" | "textarea" | "select";
}[]content_feed: boolean
file_import: boolean
provider: "google_drive" | "rss"
requires_oauth: boolean
IntegrationsIntegrationProviderName: "google_drive" | "rss"
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
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
whatsappInteractive?: { [key: string]: unknown };
}files: (
| string
| {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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?: stringOptionalwhatsappInteractive?: { [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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
whatsappInteractive?: { [key: string]: unknown };
}files: (
| string
| {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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?: stringOptionalwhatsappInteractive?: { [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: {
message_options?: {
files: (
| string
| {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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` cannot be sent through this endpoint today.** Both need `in_response_external_id` — the id of the post or comment being answered — and the endpoint does not read it from the body, so the message would leave with an empty recipient. Use them only through the network's own webhook flow.Optionalmessage_options?: {
files: (
| string
| {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
whatsappInteractive?: { [key: string]: unknown };
}files: (
| string
| {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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?: stringOptionalwhatsappInteractive?: { [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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}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?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
Optionalactual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
OrganizationsOrganizationCreate: {
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
name: string;
}Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
name: string
OrganizationsOrganizationList: {
organizations: {
_id: string;
actual_asigned?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
actual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}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?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
Optionalactual_use?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
};
stats_settings?: { auto_refresh_twitter: boolean };
}Optionalactual_plan?: {
accounts: number;
ai_credits?: number;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
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;
artificial_inteligence?: boolean;
integrations: number;
publications: number;
space: number;
stats?: boolean;
twitter_credits?: number;
users: number;
whatsapp?: boolean;
}accounts: number
Optionalai_credits?: numberOptionalartificial_inteligence?: booleanintegrations: number
publications: number
space: number
Optionalstats?: booleanOptionaltwitter_credits?: numberusers: number
Optionalwhatsapp?: boolean
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;
creation_date: string;
engagement_base?: "reach" | "impressions" | "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}_id: string
creation_date: string
Format: date-time
Optionalengagement_base?: "reach" | "impressions" | "followers"Optionalexternal_identifier?: stringfiles: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
}Optionalid_integration?: stringid_organization: string
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
Optionalname?: stringOptionalnext_stats_update?: stringFormat: date-time
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` and the client-app webhook is fired.publication_type: "profile" | "page" | "group" | "reels" | "stories" | "message"
Optionalpublish_date?: stringFormat: date-time
retries: number
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"state: "ready" | "withErrors" | "sended" | "draft" | "publishing"
Optionalstatistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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?: numberOptionalpage_likes?: numberOptionalplayback_0_count?: numberOptionalplayback_100_count?: numberOptionalplayback_25_count?: numberOptionalplayback_50_count?: numberOptionalplayback_75_count?: numberOptionalprofile_activity?: numberOptionalprofile_visits?: numberOptionalquotes?: numberOptionalreach?: numberOptionalreplys?: numberOptionalretwets?: numberOptionalsaved?: numberOptionalshare?: numberOptionalshareMentions?: numberOptionalshares?: numberOptionalsorrys?: numberOptionalurl_link_clicks?: numberOptionaluser_profile_clicks?: numberOptionalvideo_views?: numberOptionalviews?: numberOptionalwows?: number
Optionalstats_updated_date?: stringFormat: date-time
Optionaltext?: stringOptionaltitle?: stringOptionalurl?: string
PublicationsPublicationInput: {
files?: string[];
name?: string;
publication_type?: "profile" | "page" | "group" | "reels" | "stories";
publish_date?: string;
social_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "bluesky"
| "discord";
state?: "ready"
| "withErrors"
| "sended"
| "draft"
| "publishing";
text?: string;
title?: string;
}Optionalfiles?: string[]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
Optionalsocial_network?:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "bluesky"
| "discord"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.Optionaltitle?: string
PublicationsPublicationList: {
publications: {
_id: string;
creation_date: string;
engagement_base?: "reach" | "impressions" | "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}[];
total: number;
}PublicationsPublicationOne: {
publication: {
_id: string;
creation_date: string;
engagement_base?: "reach" | "impressions" | "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
}publication: {
_id: string;
creation_date: string;
engagement_base?: "reach" | "impressions" | "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}_id: string
creation_date: string
Format: date-time
Optionalengagement_base?: "reach" | "impressions" | "followers"Optionalexternal_identifier?: stringfiles: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
}Optionalid_integration?: stringid_organization: string
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
Optionalname?: stringOptionalnext_stats_update?: stringFormat: date-time
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` and the client-app webhook is fired.publication_type: "profile" | "page" | "group" | "reels" | "stories" | "message"
Optionalpublish_date?: stringFormat: date-time
retries: number
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"state: "ready" | "withErrors" | "sended" | "draft" | "publishing"
Optionalstatistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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?: numberOptionalpage_likes?: numberOptionalplayback_0_count?: numberOptionalplayback_100_count?: numberOptionalplayback_25_count?: numberOptionalplayback_50_count?: numberOptionalplayback_75_count?: numberOptionalprofile_activity?: numberOptionalprofile_visits?: numberOptionalquotes?: numberOptionalreach?: numberOptionalreplys?: numberOptionalretwets?: numberOptionalsaved?: numberOptionalshare?: numberOptionalshareMentions?: numberOptionalshares?: numberOptionalsorrys?: numberOptionalurl_link_clicks?: numberOptionaluser_profile_clicks?: numberOptionalvideo_views?: numberOptionalviews?: numberOptionalwows?: number
Optionalstats_updated_date?: stringFormat: date-time
Optionaltext?: stringOptionaltitle?: stringOptionalurl?: string
PublicationsPublicationRetry: {
max_retries: number;
publication: {
_id: string;
creation_date: string;
engagement_base?: "reach" | "impressions" | "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
};
}max_retries: number
publication: {
_id: string;
creation_date: string;
engagement_base?: "reach" | "impressions" | "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}_id: string
creation_date: string
Format: date-time
Optionalengagement_base?: "reach" | "impressions" | "followers"Optionalexternal_identifier?: stringfiles: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
}Optionalid_integration?: stringid_organization: string
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
Optionalname?: stringOptionalnext_stats_update?: stringFormat: date-time
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` and the client-app webhook is fired.publication_type: "profile" | "page" | "group" | "reels" | "stories" | "message"
Optionalpublish_date?: stringFormat: date-time
retries: number
social_network:
| "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord"state: "ready" | "withErrors" | "sended" | "draft" | "publishing"
Optionalstatistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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?: numberOptionalpage_likes?: numberOptionalplayback_0_count?: numberOptionalplayback_100_count?: numberOptionalplayback_25_count?: numberOptionalplayback_50_count?: numberOptionalplayback_75_count?: numberOptionalprofile_activity?: numberOptionalprofile_visits?: numberOptionalquotes?: numberOptionalreach?: numberOptionalreplys?: numberOptionalretwets?: numberOptionalsaved?: numberOptionalshare?: numberOptionalshareMentions?: numberOptionalshares?: numberOptionalsorrys?: numberOptionalurl_link_clicks?: numberOptionaluser_profile_clicks?: numberOptionalvideo_views?: numberOptionalviews?: numberOptionalwows?: number
Optionalstats_updated_date?: stringFormat: date-time
Optionaltext?: stringOptionaltitle?: stringOptionalurl?: string
PublicationsPublicationsStatsList: {
metric?: string;
publications?: {
_id: string;
creation_date: string;
engagement_base?: "reach" | "impressions" | "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}[];
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;
creation_date: string;
engagement_base?: "reach" | "impressions" | "followers";
external_identifier?: string;
files: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
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";
username?: string;
};
id_integration?: string;
id_organization: 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;
};
name?: string;
next_stats_update?: string;
publication_errors: {
code: number;
data?: { [key: string]: unknown };
message: string;
}[];
publication_type: | "profile"
| "page"
| "group"
| "reels"
| "stories"
| "message";
publish_date?: string;
retries: number;
social_network: | "facebook"
| "instagram"
| "linkedin"
| "tiktok"
| "twitter"
| "whatsapp"
| "youtube"
| "google_business"
| "bluesky"
| "discord";
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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
}[]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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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";
statistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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?: numberOptionalpage_likes?: numberOptionalplayback_0_count?: numberOptionalplayback_100_count?: numberOptionalplayback_25_count?: numberOptionalplayback_50_count?: numberOptionalplayback_75_count?: numberOptionalprofile_activity?: numberOptionalprofile_visits?: numberOptionalquotes?: numberOptionalreach?: numberOptionalreplys?: numberOptionalretwets?: numberOptionalsaved?: 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"Optionalstatistics?: {
angers?: number;
bookmarks?: number;
clicks?: number;
comments?: number;
engagement?: number;
follows?: number;
hahas?: number;
impressions?: number;
likes?: number;
loves?: number;
negative_feedback?: number;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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?: numberOptionalpage_likes?: numberOptionalplayback_0_count?: numberOptionalplayback_100_count?: numberOptionalplayback_25_count?: numberOptionalplayback_50_count?: numberOptionalplayback_75_count?: numberOptionalprofile_activity?: numberOptionalprofile_visits?: numberOptionalquotes?: numberOptionalreach?: numberOptionalreplys?: numberOptionalretwets?: numberOptionalsaved?: 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;
page_likes?: 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;
replys?: number;
retwets?: number;
saved?: 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.Optionalangers?: numberOptionalbookmarks?: numberOptionalclicks?: numberOptionalcomments?: numberOptionalengagement?: numberOptionalfollows?: numberOptionalhahas?: numberOptionalimpressions?: numberOptionallikes?: numberOptionalloves?: numberOptionalnegative_feedback?: numberOptionalpage_likes?: numberOptionalplayback_0_count?: numberOptionalplayback_100_count?: numberOptionalplayback_25_count?: numberOptionalplayback_50_count?: numberOptionalplayback_75_count?: numberOptionalprofile_activity?: numberOptionalprofile_visits?: numberOptionalquotes?: numberOptionalreach?: numberOptionalreplys?: numberOptionalretwets?: numberOptionalsaved?: 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"StatsSettings: { auto_refresh_twitter: boolean }
auto_refresh_twitter: boolean
Success: { success: boolean }
Upload: {
_id: string;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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
Optionalcover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; }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";
}[]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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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;
cover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; };
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";
}[];
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
Optionalcover_image?: { _id: string; cover_image?: ...; cover_offset?: number; creation_date: string; file_externals: { external_identifier: string; external_url: string; social_network: "facebook" | "instagram" | ... 7 more ... | "discord"; }[]; ... 6 more ...; public_path: string; }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";
}[]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
AI plan identifier