Get App Push Statistics
  • 07 Aug 2023
  • 1 Minute to read

    Get App Push Statistics


      Article Summary

      Overview

      You can use this service to get the statistics of the single push notifications that are sent in the current day using a predefined web service. These statistics include the campaigns created from the beginning of the day (00:00) to the time of the API request. For instance, if you send a request at 14:50, the API will return the campaigns created between 00:00-14:50.

      Endpoint and Headers

      POST https://mobile.useinsider.com/api/v1/notification/get_statistics

      Headers

      HeaderSample Value
      Content-Typeapplication/json

      Body Parameters

      ParameterDescriptionData TypeRequired
      api_keyYour API key. Refer to API Authentication Tokens to get your API key.StringYes

      Sample Example

      Sample Body

      {
          "api_key": "Your API Key goes here"
      }

      Sample Responses

      200 OK

      The successful response will return the following metrics:

      ParameterDefinition
      idCampaign ID
      nameCampaign name
      delivery_countThe number of users the campaign is delivered to
      session_countThe number of users who open the campaign
      open_rateOpens/deliveries
      messageThe campaign message
      titleThe campaign title
      segment_nameThe name of the segment that is targeted in the campaign
      deep_link/deep link keyThe deep link the users are redirected to
      push_imageThe image URL of the campaign
      {
          "campaigns": [
              {
                  "id": Camp ID,
                  "name": "My message",
                  "delivery_count": 10,
                  "session_count": 10,
                  "open_rate": "Campaign's Open Rate",
                  "message": "Campaign's Message ",
                  "title": "Campaign's Title",
                  "segment_name": "Campaign's Segment Name",
                  "deep_link": {
                      "Deep Link Key": "Deep Link Value"
                  },
                  "push_image": "Image URL"
              }
          ]
      }

      401 Unauthorized

      This response indicates that the API key is invalid or incorrect.

      {
          "error": "Bad Api Key."
      }

      401 Unauthorized

      The following response returns if the API key is empty.

      Api key can not be empty.

      Limitations

      • All functions must be executed with a simple HTTPS POST request.
      • The API key should be provided in the request body. If the key is incorrect, no operation will be executed.

      Was this article helpful?

      ESC

      Eddy, a super-smart generative AI, opening up ways to have tailored queries and responses