Get Origin of Message Sent
    • Dark
      Light
    • PDF

    Get Origin of Message Sent

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/engagement-dashboard/messages/origin
    Premium tag

    Get the origin of messages sent during a specific period. It highlights the number of messages sent in private channels, private chats, and public channels.

    Permission required: view-engagement-dashboard

    Changelog

    VersionDescription
    3.1.0Added
    Header parameters
    X-Auth-Token
    stringRequired

    The token of the authenticated user.

    ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
    X-User-Id
    stringRequired

    The user ID of the authenticated user.

    ExamplerbAXPnMktTFbNpwtJ
    Query parameters
    start
    stringRequired

    The start date.

    Example2023-10-29T14:48:00.000Z
    end
    stringRequired

    The end date.

    Example2023-11-05T14:48:00.000Z
    Responses
    200

    t denotes the type of room where the messages are sent. The types of rooms can be any of the following:

    • d represents Private Chats
    • c represents Public Channels
    • p represents Private Channels
    Success Example
    {
      "origins": [
        {
          "messages": 7302,
          "t": "c"
        },
        {
          "messages": 1147,
          "t": "d"
        },
        {
          "messages": 122,
          "t": "p"
        }
      ],
      "success": true
    }
    Expand All
    object
    origins
    Array of object
    object
    messages
    integer
    t
    string
    success
    boolean
    400

    Bad Request

    Missing key
    {
      "success": false,
      "error": "Match error: Missing key 'start'"
    }
    Example 2
    {
      "success": false,
      "error": "Match error: Failed Match.Where validation in field start"
    }
    object
    success
    boolean
    error
    string
    401

    Unauthorized

    Authorization Error
    {
      "status": "error",
      "message": "You must be logged in to do this."
    }
    object
    status
    string
    message
    string
    403

    Forbidden

    Permission Error
    {
      "success": false,
      "error": "User does not have the permissions required for this action [error-unauthorized]"
    }
    object
    success
    boolean
    error
    string


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.