peskybird
API reference › Your account

Check your limits

GEThttps://peskybird.app/api/push/limits
Auth App token

How much of the daily message limit is used and when it resets, plus the other limits, without sending.

Response 200

Limits and usage.

  • messagesPerDayobject

    Messages accepted today. Present when the server limits daily sends.

    Fields (3)
    • limitintegerRequired

      The most allowed.

    • usedintegerRequired

      How much is used now.

    • resetAtdate-time

      When used goes back to 0, for a limit that resets.

  • topicsobject

    Topics that exist. Present when the server limits topics.

    Fields (3)
    • limitintegerRequired

      The most allowed.

    • usedintegerRequired

      How much is used now.

    • resetAtdate-time

      When used goes back to 0, for a limit that resets.

  • devicesobject

    Paired devices, pending or active. Present when the server limits devices.

    Fields (3)
    • limitintegerRequired

      The most allowed.

    • usedintegerRequired

      How much is used now.

    • resetAtdate-time

      When used goes back to 0, for a limit that resets.

  • requestsPerSecondinteger

    Burst rate per app token. Present when the server states one.

    more than 0
  • imagesEnabledboolean

    Whether messages may carry an image. Absent means the server does not restrict it.

  • maxBodyBytesintegerRequired

    Largest request body, in bytes.

    more than 0
  • bodyMaxCharsintegerRequired

    Longest message body, in characters.

    more than 0
  • retentionDaysintegerRequired

    How long messages are kept, in days.

    more than 0

Errors

401unauthorized: The Authorization header is missing, or the token is not valid or has been revoked.
403forbidden: The token may not send to this topic, or the account does not allow what was asked. details.reason says which: topic_limit, images_not_enabled or account_suspended.
429rate_limited: The account reached its daily limit, or the token sent too fast.

Every error uses the same envelope. Error format and codes