API Reference FoPost v#0.1.0

Copy Markdown View Source

Modules

The official Elixir SDK for the FoPost API.

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.

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 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.

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.

One post-to-account delivery.

The single error type every FoPost call answers with.

Every reachable account's health, plus the counts per status.

A campaign tag posts are grouped and reported by.

Labels — the campaign tags posts are grouped and reported by.

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.

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.