Documentation

  1. Home
  2. Documentation
Need Help?

Visit the support center for answers to common questions and for ways to get in touch.

Got Feedback?

We'd love to hear what you have to say about our documentation. Let us know how we can improve it.

Pub/Sub Topics API

Retrieve a list of your app's topics and subscribers count.

Note: Please refer to the Device Info API to retrieve a specific device's list of subscribed topics.

  • API Reference
  • Test it out 
  • GET https://api.pushy.me/topics?api_key=SECRET_API_KEY

    Note: Make sure to replace SECRET_API_KEY with your app's Secret API Key, available in the Pushy Dashboard (Click your app -> API Authentication tab). This is a backend API endpoint. Never expose your application's Secret API Key in your client code.

    API Response

    Sample Response Body

    {
    "topics": [
        {
            "name": "news",
            "subscribers": 2
        },
        {
            "name": "media",
            "subscribers": 1
        }
    ]
}
    Response Schema
    Field Description Example
    topics
    Object[]     		Array of objects containing each result.
    - name
    String     		The Pub/Sub topic name. "news"
    - subscribers
    Integer     		The Pub/Sub topic subscriber count. 2
    API Error Reference

    Sample Error Response

    {
    "code": "INVALID_API_KEY",
    "error": "The Secret API Key you used to authenticate is invalid."
}

    There are no endpoint-specific error codes. Please consult the general error reference. 

  • GET https://api.pushy.me/topics?api_key=SECRET_API_KEY
    URL Param Value
    SECRET_API_KEY
    API Response

    500 CLIENT ERROR

    N/A