REST API
Posts
Publish, read, retry and delete.
GET/v1/posts
Recent publishes, newest first. Replies are not listed as posts.
Paging
| Name | Type | Description |
|---|---|---|
limit | query | 1-100, defaults to 20. |
before | query | A publish id from a previous page's nextBefore. Returns the ones older than it. |
includeDeleted | query | true brings back posts you deleted from the channel. They are hidden by default. Our record and its metrics stay either way. |
status | query | Narrow to one or more statuses, comma separated: scheduled, draft, publishing, published, partial, failed or cancelled. Omit for everything, scheduled and draft included. |
since | query | YYYY-MM-DD or ISO 8601 with a four-digit year. Posts dated at or after this. A scheduled post is dated by scheduledAt, a sent one by when it was created. A value that is not a real date, or a year past 9999, is refused with invalid_params. |
until | query | YYYY-MM-DD or ISO 8601 with a four-digit year. Posts dated at or before this; a date means the whole day. A value that is not a real date, or a year past 9999, is refused with invalid_params. |
sort | query | scheduled orders by the post's date ascending and drops paging. Omit for newest first. |
hasMore | response | The list was cut short. |
nextBefore | response | Pass it back as before. Absent when there is nothing more. |
POST/v1/posts
Publish to one or more connected accounts.
| Name | Type | Description |
|---|---|---|
contentRequired | string | Post text. Emoji count as UTF-8 bytes. |
accountIdsRequired | string[] | Ids from GET /v1/accounts. |
mediaIds | string[] | Media already confirmed with complete. On Naver Blog you may leave out ids the body already points at with media:<id>; we read those from the text and attach them. |
options | object | Per-channel settings, keyed by the channel id. The shape is in GET /v1/platforms under options and on each channel page. Some channels cannot publish without it β YouTube needs options.youtube.title and Naver Blog needs options.naver_blog.title plus a category. Every channel takes options.<channel>.content, a different text for that channel alone. |
scheduledAt | string | ISO 8601 with a timezone offset, 10 minutes to a year out. We keep the post as scheduled and send it at that time, on every channel. |
draft | boolean | true saves the post without sending. It can have no accountIds yet. Send it later with POST /v1/posts/{id}/publish. |
batchId | string | Optional tag, up to 40 characters, to group posts made together (for example the same text sent to two workspaces). Comes back on every post. |
replyTo | string | The post or reply to answer: its id on the channel, our publish id (post_β¦), or a link to the post. A publish id or a link becomes that post's id on the replying account's channel, so send one account per request. A Threads, Instagram, Facebook or Bluesky link works only for a post we have on record. |
threadItems | object[] | Split a long post into a chain: [{ content, mediaIds? }]. The first item is the root, the rest become replies under it in order. Each item obeys the character limit on its own. Exclusive with content. Only Threads, Bluesky and X take a chain; the composer builds one with the item editor. If a later item fails the ones already up stay up, and the response carries thread.resumeFrom. If an item fails, the later items on that account close as failed with errorCode thread_broken, and retry_post continues from the item that failed. Posts that have later items carry them back as threadItems, and PATCH takes the same field while the post is scheduled or a draft. |
topicTag | string | One topic to tag the post with. Threads takes exactly one and rejects periods and ampersands. On a thread it applies to the first piece only. This top-level field is an alias: if a channel in the call does not take topics, the whole call is refused. To tag only the Threads part, use options.threads.topicTag. |
Idempotency-Key | header | Send the same key when you retry and we return the first answer instead of publishing twice. Reusing a key with a different body is a 422. Kept for 24 hours. |
wait | boolean | Hold the response until the post is really out. Text waits up to 10 seconds, media up to 75. Past that you get the usual 202 with a next hint, and the post keeps going. Defaults to false. |
curl -X POST https://api.uplika.com/v1/posts \
-H "authorization: Bearer $UPLIKA_KEY" \
-H "content-type: application/json" \
-d '{
"content": "Now with images",
"accountIds": ["acc_01H..."],
"mediaIds": ["med_01H..."]
}'GET/v1/posts/{id}
One publish with the status of each target.
Target status
| Name | Type | Description |
|---|---|---|
publishing | status | In flight at the channel. |
published | status | Carries externalId and url. If the account was disconnected afterwards, the target stays published with connectionId null and accountHandle set to that account's handle until the same account is reconnected. |
partial | status | Some channels went out and some did not. Retry sends only the ones that failed. There is no 207 β publishing is 202 plus polling, so nothing is held open. |
cancelled | status | Deleted from the channel. Our record and its metrics stay. Hidden from GET /v1/posts unless you pass includeDeleted=true. |
failed | status | Carries error. |
scheduled | status | Held until scheduledAt. Nothing is on any channel yet. Editable. |
draft | status | Saved without a time. May have no targets. Editable. |
A publish has one row per channel. publishing is in flight, published carries the channel's own id and URL, failed carries a reason.
What an X post cost
On X targets only, the target row carries billing: { operation, mills, state, balanceMills }. operation is post, post_url for a post containing a link, or reply for a reply, which includes each piece of a chain after the first. mills is what that post cost from X credits in thousandths of a US dollar, attached files and alt text included. state is reserved while it is going out, confirmed once X took it, or released when it was handed back. balanceMills is the person's X credit balance now. It is on single-post responses (GET /v1/posts/{id}, and the post in GET /v1/posts/{id}/thread) and on publish responses. List endpoints do not carry it. When the balance cannot cover a post, publishing answers 402 x_credits_insufficient with topUpUrl and nothing goes out.
What can go in {id}?
Any way you have of naming the post: the publish id (post_β¦), the post's own id on the channel, its shortcode, or a link to it. Put a link through encodeURIComponent so it stays one path segment. postId on POST /v1/engagement/like and on the /v1/replies/{replyId} calls takes the same values. A post written in the channel's app is found on that channel the first time and kept as an imported record, so replies, insights, edits and deletes work on it; the next call with the same link reads our record and does not call the channel. Finding a shortcode reads the account's recent posts (up to 500), so an older one comes back post_not_in_recent with scanned, and its id on the channel works instead. A post on a channel this workspace has not connected is post_not_owned. A Naver post on someone else's blog is naver_wrong_blog: reply to it or like it with ownerHandle and externalId on POST /v1/engagement/reply or /v1/engagement/like. A YouTube link on a day uplika's YouTube allowance is used up answers 429 youtube_quota_exhausted. replyTo on POST /v1/posts takes a publish id or a link too, and we send that post's id on the replying account's channel. A Threads, Instagram, Facebook or Bluesky link works only for a post we have on record. A link or a channel's own id names one channel's copy, while DELETE and an edit of a published post (PATCH) act on every channel the post went out on: when the post is also on other channels they answer 409 post_spans_channels with postId and channels and change nothing. Call again with that postId to act on every channel.
Scheduling and drafts
Pass scheduledAt and we keep the post as scheduled and send it at that time, on every channel, from our side. Pass draft: true and nothing goes out until someone calls publish or the dashboard does. Both come back with status scheduled or draft, can be changed with PATCH, sent early with /publish, and removed with DELETE. scheduledAt needs a timezone offset and is 10 minutes to a year out. Some channels also have scheduling of their own (options.youtube.publishAt, options.facebook.scheduledPublishTime, options.naver_blog.scheduledAt); those still work over the API but the dashboard hides them, because two clocks on one post is a contradiction waiting to happen.
Different text per channel
Every channel takes options.<channel>.content. When set it replaces the shared content for that channel only, and the length and media checks use it. That is how a 500-character Threads post and a Naver Blog Markdown body fit in one call. GET /v1/platforms lists what else each channel takes, under options.
PATCH/v1/posts/{id}
Change a scheduled or draft post before it goes out. Fields you leave out keep their value, except that a post going only to Naver Blog takes its media list from the new body's media: references when you leave mediaIds out; options replaces the whole object; threadItems replaces a chain, content alone edits its first item. Editing a post that is already live is asynchronous: wait: true holds the response for the result (up to 75 seconds), and past that it answers 202 with next telling you to read the post. A Naver draft save that went quiet is looked up in Naver's draft list and recovered when it is there. A post published with publish_naver_draft is edited like a post written in Naver's editor: the first update returns its current source (409 naver_source_required) and the rewrite goes out with sourceVersion, so the photos and formatting Naver has stay. A Naver post published through uplika takes the same path once its uploaded photo files have been cleaned up (about a day after it went out): changing only options goes out directly, and changing the body returns the current source first.
| Name | Type | Description |
|---|---|---|
content | string | New post text. |
accountIds | string[] | New target accounts. Replaces the current set. |
mediaIds | string[] | New media, in order. Replaces the current set. On a post going only to Naver Blog, leave it out when the body places media with media: references: those references become the list and media the new body does not place is removed (the response note says how many). |
options | object | Per-channel settings. Replaces the whole object. |
scheduledAt | string | New send time, same rules as on create. null turns the post into a draft. |
draft | boolean | true turns a scheduled post, or a Naver Blog post still waiting for the browser extension, back into a draft. |
POST/v1/posts/{id}/publish
Send a scheduled or draft post right now. Same function the scheduler runs, so it cannot go out twice.
| Name | Type | Description |
|---|---|---|
wait | boolean | Hold the response until the post is really out, same as on create. |
POST/v1/posts/{id}/retry
Retry the targets that failed. Targets that already went out are skipped. A Naver target that stopped right after Save as draft (naver_draft_unknown) a Naver reply that did not confirm in time (naver_reply_unknown), a WordPress post the site never confirmed (wordpress_publish_unconfirmed), a Naver Clip that was posted but not confirmed in the clip list (clip_unconfirmed, check Clip Creators > Content first), an X post that was sent and then got no usable answer (x_publish_unknown, check the X account first), a TikTok post that was sent and then lost its connection before TikTok answered (tiktok_publish_unknown, check the TikTok profile first), a post that is live but held by an imported copy of it (published_as_imported_copy, use that copy), or a target that stopped before the channel answered (publish_outcome_unknown, check that channel first; if it is there, send the other channels as a new post) answers 409 until the body carries {"force": true}. If another post with the same content and the same files is already on the same account (a file uploaded again counts as the same file), it answers 409 duplicate_post with that post's id and retries nothing; {"force": true} sends it anyway.
DELETE/v1/posts/{id}
Delete the post from every channel it went out on and mark our record deleted.
On a scheduled or draft post nothing is on any channel yet, so DELETE simply removes our record. On a post that went out it deletes from every channel it went out on first and keeps our record marked deleted. If the post was named by a link or a channel's own id and it is also on other channels, DELETE answers 409 post_spans_channels with postId and channels and calls no channel; the same call with that postId deletes it everywhere. If a channel's trash is turned off, so the post is gone for good, the response adds note (the sentence to pass on) and permanentlyDeleted (the channel names). A Naver draft is removed by the browser extension when its turn comes in that browser; if that has not finished within 60 seconds, the response adds note saying so and the extension finishes it within 30 minutes.
Deleting a post on X is charged X's delete price from the person's X credits. If the balance is too low, DELETE answers 402 x_credits_insufficient with topUpUrl. The balance is checked before any channel is called, so nothing is deleted; if another call spent it in the meantime, the message names the channels already deleted.
Reading what is already on the channel
Our history only has what went out through us. These four read the channel itself and pick which channels to publish to. They are the routes behind list_channel_posts, get_quota, open_post and select_channels, so an agent gets the same answers over REST.
GET/v1/posts/{id}/thread
One post with its replies and metrics in a single call.
| Name | Type | Description |
|---|---|---|
accountId | query | Which channel's copy to read, on a post that went to more than one channel. Omit and the answer says which copy it read. |
GET/v1/channels/posts
What is on the channel right now, including posts written in the app.
Query
| Name | Type | Description |
|---|---|---|
accountId | query | Limit to one connected account. Omit to cover every channel. |
limit | query | 1-100, defaults to 25. |
GET/v1/channels/quota
How much of the 24 hour allowance the channel says is used. When an X account is in scope the response also carries xCredits: { balanceMills, topUpUrl }, the person's prepaid X credit balance in thousandths of a US dollar (0 when nothing was ever bought) and where to top it up.
GET/v1/channels/bridge
Whether the Naver Blog bridge (browser extension) is online, and how to wake Chrome if it is not.
GET/v1/channels/publish-options
What a channel needs to know before you publish to it. TikTok only: the creator nickname the post goes out as, the privacy levels this account may use right now, whether it can post at all, and its video length limit. Other channels return not_supported.
| Name | Type | Description |
|---|---|---|
accountId | query | Required. These values are per connected account and change when the person edits their channel settings, so do not cache them. |
GET/v1/channels/instagram/audio
Music and original sounds one Instagram account can put on a reel, for options.instagram.audio. Instagram only, and only for accounts connected via Facebook. Without query it lists what is trending for that account; with query, music comes only from Meta's royalty-free Sound Collection, so an artist or song name will not find that song. There is no sort or date option, no count of reels using a sound and no creation date, matching is strict about spelling and spacing, and licensed songs in the trending list come with no audio file.
| Name | Type | Description |
|---|---|---|
accountId | query | Required. A connected Instagram account. Trending audio differs per account, so use ids from the same account's results. |
type | query | music (default) or original_sound. |
query | query | Optional, up to 100 characters. Without it you get this account's trending audio. With type music it searches royalty-free music from Meta's Sound Collection only. Matching is strict about spelling and spacing. |
limit | query | 1-50, defaults to 25. |
cursor | query | nextCursor from the previous page, unchanged. |
POST/v1/accounts/select
Pick which connected channels to publish to.
POST/v1/accounts/:id/refresh
Re-read a channel's metadata, such as Naver Blog categories or Pinterest boards. Waits up to a minute for the browser extension.
| Name | Type | Description |
|---|---|---|
scope | string | string[] | Omit to list candidates. "all" for every active channel, or an array mixing platform names, handles and account ids. |
PUT/v1/accounts/:id/pinterest/default-board
Set the board a Pinterest connection pins to when a post leaves out options.pinterest.boardId. The board must be in the connection's board list; call refresh first for a board made after connecting.
| Name | Type | Description |
|---|---|---|
boardId | string | Required. A board id from the account's pinterest.boards in GET /v1/accounts. Answers with the account, pinterest.defaultBoardId updated. |
| Name | Type | Description |
|---|---|---|
blogRequired | string | A Naver blog id (2-40 letters, digits, - or _) or any link to the blog: blog.naver.com/<id>, m.blog.naver.com/<id>/<logNo>, PostView.naver?blogId=<id>. |
| Name | Type | Description |
|---|---|---|
keywords | string[] | Required. 1-300 keywords. Spaces are fine; the numbers come back per keyword as you sent it. |
save | boolean | Default false. true stores this research as a report (the keywords, the first set's main and subs, every set with its prompt) and returns reportId. The same person sending the same keyword set within ten minutes gets the existing reportId back with no new row and no judge call spent. |
seedText | string | What the person typed, kept with the saved report as its label. Defaults to the first five keywords. |
cacheOnly | boolean | Default false. true never calls Naver: keywords without a fresh cached value come back in unmeasured with no numbers. Use it after measuring in chunks, so the judge call is instant and spends nothing upstream. |
budgetMs | number | Time budget for new measurements, default and maximum 60000. When it runs out, no new upstream call starts; the response says partial: true and lists unmeasured. Call again and the cached part is skipped. |
| Name | Type | Description |
|---|---|---|
keywords | string[] | Required. 1-300 keywords. At most 40 of them are measured fresh in one call; the rest come back in unmeasured and are picked up by the next call. |
withDocs | boolean | Default true. false measures search volume only. |
budgetMs | number | Time budget for new measurements, default and maximum 60000. Past it the call stops starting upstream requests and returns partial: true with unmeasured. |
| Name | Type | Description |
|---|---|---|
seeds | string[] | Required. 1-10 seed keywords. Each is sent to Naver autocomplete once (one level); the words that come back are candidates to measure with judge, not proven keywords. Cached seven days across users. No daily quota: when the person's uplika Chrome extension answers there is no wait, and when our server answers, one call per person every 60 seconds (naver_autocomplete_busy with retryAfterSeconds). |
What comes back
| Name | Type | Description |
|---|---|---|
found | { keyword, from }[] | Every word, the seeds first. from is seed, or L1:<seed> for a word that seed produced. |
errors | { query, error }[] | Seeds that could not be looked up, with why. |
cached | number | How many seeds came from the seven-day cache. |
via | { cache, extension, server } | How many seeds each path answered: the shared cache, the person's Chrome extension (in the background, from their own connection), or our server. |
| Name | Type | Description |
|---|---|---|
limit | number | Default 50, newest first. |
| Name | Type | Description |
|---|---|---|
keywordRequired | string | The keyword, as you would send it to measure. A query parameter, since keywords are usually Korean. |
limit | number | Default 100 days, newest first. |
tz | number | The viewer's time zone offset in minutes, with the sign of JavaScript getTimezoneOffset (Korea is -540). Measurements fold into that zone's days. Default 0 (UTC). |
GET/v1/research/youtube/search
Search YouTube for a keyword and get the top videos with views, subscribers, length and publish date as YouTube gives them, the views-to-subscribers ratio and Shorts or long-form (both calculated by uplika, not YouTube metrics; dataNotes says so), plus a ready-to-paste prompt for titles and hooks in the person's Uplika language (Korean or English). The same search is cached 24 hours and does not count; a new one spends one of the person's daily searches (quota in the response) and shared YouTube Data API units. Saved to the person's history with reportId.
| Name | Type | Description |
|---|---|---|
qRequired | string | The search words, as a viewer would type them. |
order | string | viewCount (default), date or relevance. |
period | string | 7d, 1m, 3m, 6m or 1y. Omit for no limit. |
format | string | all (default), shorts or long. 60 seconds or less counts as a Short. |
max | number | 1-50, default 25. |
topic | string | The video the person wants to make, one line. Goes into prompt and is saved with the report. |
GET/v1/research/youtube/reports
The person's saved YouTube searches, newest first: when, the search and its filters, the topic, how many videos and whether it came from cache. Results are kept for up to 30 days, then deleted. History belongs to the person, so an API key that does not cover all of the person's workspaces gets 403 forbidden_scope.
| Name | Type | Description |
|---|---|---|
limit | number | Default 50, newest first. |
GET/v1/research/youtube/reports/{id}
One saved search with the videos as they were and the prompt built from them. History belongs to the person, so an API key that does not cover all of the person's workspaces gets 403 forbidden_scope.
POST/v1/google/keywords/research
Google search volume for up to 10 keywords in a country the person chooses: average monthly searches, the last 12 months, ad competition and top-of-page bids, plus related keywords with the same numbers. Bids come in bidCurrency, the currency of uplika's Google Ads account, the same for every country and not converted. Search counts are Google's rounded figures. A keyword with no data from Google is listed in noData, which is not zero. Put every keyword in one search; a comma-separated string works too. The same search is cached 7 days. There is no per-person daily limit. Beta: the person can turn it off for API keys.
| Name | Type | Description |
|---|---|---|
keywordsRequired | string[] | 1 to 10 keywords, as the person wrote them. A comma-separated string or an item with commas is split into keywords. |
countryRequired | string | Two-letter country code such as KR or US. Required, with no default. Ask the person which country they mean. |
language | string | Language code such as ko or en. Leave it out to use the country's main language. |
max | number | How many related keywords to return, biggest first. 1-200, default 50. |
GET/v1/research/ads/search
Public ads from Meta's Ad Library (Facebook, Instagram, Threads, Messenger) by keyword or by advertiser, not the person's own ad account. Up to 30 ads per page with the advertiser, text, start date, how many days each has been running, platforms, format, thumbnailUrl (expires in a few days) and libraryUrl, plus a cursor for the next page and today's usage. Meta publishes spend and impressions only in the EU, so those never appear. To see more ads by the same advertiser, pass an ad's advertiser.pageId back as advertiserId. The same search within 24 hours is cached and free; each page that reaches the provider spends one of the person's daily ad searches. Beta, so the person can turn it off for API keys.
| Name | Type | Description |
|---|---|---|
q | string | Keywords, as a viewer would search them, up to 100 characters. Pass q or advertiserId, not both. |
advertiserId | string | A Facebook page id from /v1/research/ads/advertisers. Lists that advertiser's ads instead of searching words. |
country | string | Two-letter code of the country the ads were shown in. Default KR. |
status | string | active (default), inactive or all. |
media | string | all (default), image or video. |
sort | string | impressions (default) or relevance. There is no newest-first sort; narrow with from and to instead. |
from | string | Only ads that started on or after this date, YYYY-MM-DD. |
to | string | Only ads that started on or before this date, YYYY-MM-DD. |
exact | boolean | Default false. true keeps only ads with the exact phrase. |
koreanOnly | boolean | Default true. Drops ads without Korean text, since country KR means ads shown in Korea and foreign ones are mixed in. received and kept say how many were dropped. |
cursor | string | The cursor from the previous page. |
GET/v1/research/ads/advertisers
Facebook pages that match an advertiser name in Meta's Ad Library, verified first and then by likes, with pageId, category, likes and the Instagram handle. Several pages often share a name, so let the person pick, then pass that pageId to the search as advertiserId. Spends one daily ad search; the same name within 24 hours is cached and free.
| Name | Type | Description |
|---|---|---|
qRequired | string | A brand or page name, up to 100 characters. |
GET/v1/research/ads/{adId}/transcript
What is said in a video ad, by adId from a search result with hasVideo true. available is false when the ad has no video, no speech, runs longer than two minutes, or the data provider could not read the video. Saved for 30 days; only a new transcript spends one daily ad search.
GET/v1/research/ads/reports
The person's saved ad searches, newest first: when, keyword or advertiser, country, how many ads and whether it came from cache. The ads themselves are kept for 7 days (thumbnail links expire sooner) and the list for 30 days. History belongs to the person, so an API key that does not cover all of the person's workspaces gets 403 forbidden_scope.
| Name | Type | Description |
|---|---|---|
limit | number | Default 50, newest first. |
GET/v1/research/ads/reports/{id}
One saved ad search with the ads as they were. After 7 days resultsExpired is true and ads is null, so search again. History belongs to the person, so an API key that does not cover all of the person's workspaces gets 403 forbidden_scope.
GET/v1/research/google-ads/search
Public ads from Google's Ads Transparency Center (Search, YouTube, Shopping, Maps, Play) for one website (domain) or one advertiser (advertiserId), not the person's own Google Ads account. Up to 40 ads per page, most recently shown first, each with the advertiser, format (text, image or video), first and last day shown, runningDays, longRunning, imageUrl when Google has one and adUrl, the original ad in the Transparency Center. The list has no ad text; the person reads the ad through adUrl. Google publishes no spend or impressions. A domain result mixes resellers, partner brands and agencies under their own names, counted in advertisersOnPage. The same lookup within 24 hours is cached and free; every other page spends one daily ad-analysis lookup, shared with Meta ad analysis.
| Name | Type | Description |
|---|---|---|
domain | string | A website host such as oliveyoung.co.kr, up to 253 characters. A pasted address is reduced to its host. Pass domain or advertiserId, not both. |
advertiserId | string | A Google advertiser id (AR followed by digits) from /v1/research/google-ads/advertisers or from an ad's advertiser.id. |
region | string | Two-letter code of the country the ads were shown in. Default KR. |
platform | string | all (default), search, youtube, shopping, maps or play. |
format | string | all (default), text, image or video. |
from | string | Only ads shown at any time on or after this date, YYYY-MM-DD. |
to | string | Only ads shown at any time on or before this date, YYYY-MM-DD. |
cursor | string | The cursor from the previous page. |
GET/v1/research/google-ads/advertisers
Advertisers in Google's Ads Transparency Center that match a brand or company name, largest adsEstimate first, plus matching websites in domains. Google keeps one advertiser per registered company or account, so one brand often has several: let the person pick, then pass that advertiserId to the search. A brand name that differs from the company name can find nothing; try the company's legal name or its website. Spends one daily ad-analysis lookup; the same name within 24 hours is cached and free.
| Name | Type | Description |
|---|---|---|
qRequired | string | A brand or company name, up to 100 characters. |
region | string | Two-letter country code to search advertisers in. Default KR. |
GET/v1/research/google-ads/reports
The person's saved Google ad lookups, newest first: when, website or advertiser, country, how many ads and whether it came from cache. Meta ad searches are not in this list. The ads are kept for 7 days and the list for 30 days. History belongs to the person, so an API key that does not cover all of the person's workspaces gets 403 forbidden_scope.
| Name | Type | Description |
|---|---|---|
limit | number | Default 50, newest first. |
GET/v1/research/google-ads/reports/{id}
One saved Google ad lookup with the ads as they were. After 7 days resultsExpired is true and ads is null, so look it up again. History belongs to the person, so an API key that does not cover all of the person's workspaces gets 403 forbidden_scope.
| Name | Type | Description |
|---|---|---|
keywordsRequired | string[] | 1-10 keywords, as a reader would search them. |
blog | string | A Naver blog id or any link to the blog. Its posts are marked mine: true and each result carries verdict (bodyRank, imageRank, citedParagraphs, organicRank, organicArea, cited, exposed). |
fresh | boolean | Default false. A keyword this person read in the last 30 minutes comes back from the saved result; true reads it again and spends the daily allowance. |
blogTab | boolean | Default false. true also reads page 1 of the blog tab sorted by relevance for each keyword: each result carries blogTab (read, sort, size, top 5 posts, reason, requiredVersion when the extension is too old) and, with blog, verdict.blogTabRank. Two search pages per keyword from the daily allowance. A saved result from the last 30 minutes is reused only if its blog tab was read. |
waitMs | number | Hold the response up to this many milliseconds (at most 60000) and answer 200 with the results so far; partial: true with pending lists what the extension is still reading in the background. Without it the answer is 202 with runId. |
| Name | Type | Description |
|---|---|---|
limit | number | Default 20, at most 50, newest first. |
| Name | Type | Description |
|---|---|---|
blogRequired | string | A Naver blog id or any link to the blog. |
limit | number | How many recent posts, 1-30, default 20. |
| Name | Type | Description |
|---|---|---|
blogRequired | string | A Naver blog id or any link to the blog. |
tz | number | The viewer's time zone offset in minutes, with the sign of JavaScript getTimezoneOffset (Korea is -540). The trend groups checks into that zone's days. Default 0 (UTC). |
| Name | Type | Description |
|---|---|---|
mainKeywordRequired | string | 1-100 characters. Used from the next check on; the post's old verdict is cleared. |
title | string | The post title, used only when the post is not tracked yet (up to 300 characters). |
| Name | Type | Description |
|---|---|---|
keywordRequired | string | The keyword, up to 100 characters. A query parameter, since keywords are usually Korean. |
blog | string | Mark that blog's posts and add a verdict to each check. |
limit | number | Default 30, at most 100, newest first. |
| Name | Type | Description |
|---|---|---|
content | string | Required. The Markdown body, up to 60,000 characters. |
title | string | The post title. |
main | string | The main keyword. Without it the keyword checks cannot pass. |
subs | string[] | Sub keywords, one per section title. |
tags | string[] | The tags you will send in options.naver_blog.tags. |
fixedTags | string[] | Tags that need not appear in the body (brand tags). |
products | string[] | Product and brand names that must stay out of the first three paragraphs. |
mediaIds | string[] | The media ids attached to the post, to check that each is placed. |
| Name | Type | Description |
|---|---|---|
contentRequired | string | The markdown body to lay out. |
mediaIds | string[] | Attached media, in order. Images the body does not reference are placed by the form. |
form | string | One preset id (default photo-story). Ignored when forms is given. |
forms | "all" | string[] | Lay the same body out in several presets at once; the response carries layouts[] so a person can compare and pick. |
| Name | Type | Description |
|---|---|---|
logNoRequired | string | The draft's id from GET /v1/naver/drafts. |
accountId | string | Required only when the workspace has more than one Naver Blog account. |
title / categoryId / category / tags / openType | string | Override the draft's own values. Left out, the draft goes out as it is. |
wait | boolean | Hold until the extension finishes, up to 75 seconds like a post with media on POST /v1/posts. Past that you get the usual 202 with a next hint, and the draft keeps going out. |
| Name | Type | Description |
|---|---|---|
topic | string | One section instead of the whole guide. The 400 lists the ids. |
| Name | Type | Description |
|---|---|---|
url | string | Required. A public Naver Blog post, like https://blog.naver.com/someone/224349824125. Only blog.naver.com links work, and private or deleted posts are refused. Five per minute. |
| Name | Type | Description |
|---|---|---|
url | string | Required. The same post link you passed to extract. Answers from our database only; Naver is not called. 404 reference_not_read when it was never read. |
publishing βββΊ published the channel accepted it, permalink is set
βββΊ partial some channels made it, some did not
βββΊ failed none of them made it, error says why
failed βββΊ publishing retry, and only the targets that failed go again
published βββΊ cancelled you deleted it; our record and its metrics stayCommon questions
How do I publish to several channels at once?
Name them all in accountIds on a single call. One request creates one publish with one row per channel, so you read the outcome in one place instead of correlating separate calls.
What does a 202 actually mean?
That we accepted the post and the channels have not answered yet. Read the per-target status to know what landed; the top-level response only says the work started.
Can I delete a post after it went out?
Yes. Deleting removes it from the channel and marks our record deleted, so the history still shows that it existed and when it went.