Object

Throttling

See the object that wraps the throttling information that's returned for the create article and update article endpoints.

Properties

estimatedDelayInSeconds
integer

Estimate of the number of seconds until this request begins processing.

isThrottled
boolean

A Boolean value that indicates whether requests to this channel are currently being throttled. If true, this request is added to the queue to be processed later rather than immediately.

queueSize
integer

Number of requests currently queued for later processing.

quotaAvailable
integer

Number of additional article publish or update requests that can be submitted now, before the system begins throttling.

See Also

Articles

Create an Article

Publish an article to your channel.

Read Article Information

Retrieve information about an article, such as the revision number and maturity rating.

Search Articles in a Channel

See a list of all articles in a channel that match the specified search criteria.

Search Articles in a Section

See a list of all articles in a section that match the specified search criteria.

Update an Article

Update an existing article in your channel.

Delete an Article

Delete the specified article from your channel.

object Create Article Metadata Fields

See the optional metadata fields for the create article request.

object ArticleLinksRequest

See the required field for the create article request.

object Update Article Metadata Fields

See the metadata fields for the update article request.

object Article

See the fields returned by the article endpoints.

object ArticleResponse

See which objects make up the create article, read article, and update article responses.

object ArticleLinksResponse

See the links returned by the article endpoints.

object SearchResponse

See the fields returned by the search article endpoints.

object Meta

See the object that wraps the throttling information that's returned for the create article and read article endpoints.