Modules
A connected social account — the thing a post is delivered to.
An account's stored snapshots, newest first.
How an account's stored credentials are holding up.
One point in an account's follower history.
Connected social accounts — what a post is actually delivered to.
A boost or ad created through FoPost. :kind is "boost" or "ad"; :status is what
you set ("active" or "paused") and :effective_status is what Meta reports.
A connected ads login. :auth_type says whether it was a business or a user login.
Lifetime delivery numbers as of the ad's last refresh. :spend_minor is in the ad
account's currency, minor units.
One connection with the ad accounts and Pages its grant reaches, as lists of maps.
:error is set when the provider could not be read.
Who an ad is shown to. :locations, :interests, :behaviors, and :income are
lists of maps as Meta names them, from FoPost.Ads.search_targeting/2.
Meta ads: boosts, standalone ads, audiences, targeting, and lead forms.
Cross-account reporting.
One slice of an audience: a value and its share of the whole.
What a collection run refreshed, and what it could not.
An audience breakdown.
One campaign label's performance over the window.
The headline roll-up across every account in scope.
One day of activity in a time series.
One row of the posts table: a post and how its deliveries went.
A page of posts with their per-platform delivery breakdown.
One day of posting activity in the year-long streak.
Daily activity over the requested window, one point per day.
One high-performing post.
A saved audience on an ad account.
The audiences and pixels on an ad account. :pixels is a list of maps of id and name.
A trigger and the steps behind it.
One execution of an automation, with a log per step when fetched on its own.
Automation counts and the runs of the last day.
One action in an automation, in position order.
The run a webhook trigger started.
Automations — a trigger plus the steps it runs.
A published post that can be boosted, with the deliveries a boost can start from.
What a committed CSV import created. Keep :batch_id to roll the batch back.
One CSV row as the bulk-import validator read it.
The dry run of a CSV import: what would be created, and what would not.
How many posts a bulk action changed.
The client struct every resource function takes as its first argument.
The communities an account can post into.
An X community linked to an account.
A community as the platform's search returns it, before it is linked to an account.
Builds the :content a post is created or updated with.
One text-plus-media unit of a post. A single post has one block; a thread has one per entry, in order.
A newly created audience: its id and, for a customer list, how many emails were accepted.
One post-to-account delivery.
The single error type every FoPost call answers with.
An ad on a connected ad account that was made outside FoPost. Read live, never stored.
Every reachable account's health, plus the counts per status.
Comments, mentions, and direct messages on connected accounts.
A connected account and whether its comments (:inbox_supported) and direct messages
(:dm_supported) can be read. The *_pending_reason fields say why not.
The connected account an inbox item, thread, or conversation belongs to.
A reply an automation or the agent drafted that a person still has to send.
A file attached to an inbox item. :url and :preview_url are served by FoPost.
One direct-message thread, rolled up. :participant is the other party as a map of
name, handle, and avatar_url.
The answer to approving or rejecting a drafted reply.
One comment, mention, or direct message on a connected account.
Inbox support per platform. :comments and :dms are "live", "soon", or "none".
The platform post a comment or mention sits under.
What a manual inbox poll did. :dm_reconnect lists accounts whose DM access needs a
fresh connection, as maps of platform and account.
A sent reply: the updated item plus the reply's id and URL on the platform.
One post with comments (or mentions), rolled up: how many, how many unread, the latest.
A campaign tag posts are grouped and reported by.
Labels — the campaign tags posts are grouped and reported by.
One submission of a lead form. :fields is a list of maps of name and values.
An Instant Form on a Page.
One connection and Page with the lead forms on it.
One page of leads. Pass :next_cursor back as :after for the next page; nil means
there is none.
The media library.
One asset in a workspace's media library.
One attachment on a content block.
The bare acknowledgement several deletes and side-effect endpoints answer with.
One page of a paginated list: the rows on :data, the counters on :meta.
Pagination counters that travel alongside a paginated list.
A composed post: its content, the accounts it targets, and its schedule.
One account a post targets, with the outcome of its delivery.
A post's performance, totalled and broken down per platform.
Create, schedule, publish, and inspect posts.
One account's readiness. :issues block publishing; :signals are advisory.
A post checked against every platform it targets, without publishing anything.
What a publish, a retry, or a cancel queued.
One attempt at publishing a post, with its per-account results.
One location, interest, behaviour, or income bracket as Meta names it.
When a refreshed credential now expires.
Whether an account's credentials still work against its platform.
One webhook subscription.
A decoded webhook delivery: which event fired, its payload, and when.
Outbound webhooks — the push counterpart to polling a post's deliveries.
One workspace — the tenant boundary every other resource is scoped to.
A workspace's follower and post totals, per account and summed.
Workspaces — the tenant boundary every other resource is scoped to.