Contents

Read Channel Quota Information

Get details about your channel’s remaining quota for sending create and update requests, the queue size, and wait time.

URL

GET https://news-api.apple.com/channels/{channelId}/quota

Path Parameters

NameTypeDescription
channelId Requiredstring

The UUID of the channel. You can get your channel ID from News Publisher. See Use your CMS with News Publisher in News Publisher User Guide.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
Throttling

The request was successful.

400Bad Request
Content-Type: application/json
Error

MISSING. You didn’t include the Channel UUID field in the request. Key path: *

401Unauthorized
Content-Type: application/json
Error

You didn’t include the Authorization header. Key path: None.

403Forbidden
Content-Type: application/json
Error

You tried to access a channel your API key doesn’t have permission to access. Key path: None.

404Not Found
Content-Type: application/json
Error

  • The endpoint you tried to access doesn’t exist. Key path: None.

  • The channel you tried to access doesn’t exist. Key path: channel_id.

Discussion

A Read Channel Quota Information request returns the publisher’s remaining create and update request quota, the queue size, and estimated wait time. This information is also available through the Meta object when you use the Create an Article and Update an Article endpoints.

Example

See Also

Channel