GET Podcasts Listen Per Audio(Episodes) Graph Metrics

Overview

---

The following table contains important information about the GET method in regards to retrieving all audio data in podcast analytics based on metrics and interval types.

GET Podcasts Listen Per Audio(Episodes) Graph Metrics
Method	GET
URL or Endpoint	/api/v1/projects/projectId/audio/graph/listenPerAudio
Headers	Authorization
Parameters	metric, audioId, podcastId, isPodcast, intervalType,startDate, endDate, items, projectId
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
metric	Yes	integer($int32)	Types of metrics for receiving desired data(e.g., 2 for listeners)
audioId	No	string	Unique identifier of audio
podcastId	Yes	string	Unique identifier of podcast
isPodcast	Yes	boolean	A boolean value indicating whether it is a podcast
intervalType	Yes	integer($int32)	Types of intervals for receiving desired data(e.g., 0 for today)
startDate	No	string($date-time)	The start date you want to receive information for.
endDate	No	string($date-time)	The end date you want to receive information for.
items	No	integer($int32)	Number of items you want to receive
projectId	Yes	string	The id of the project.

tip

Click here to see more for metrics and interval types.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "listensPerAudio": {
      "{audioId}": {
        "{audioTitle}": [
          {
            "listens": 1,
            "date": "2024-07-08T00:00:00"
          }
        ]
      },
      "{audioId}": {
        "{audioTitle}": [
          {
            "listens": 1,
            "date": "2024-07-08T00:00:00"
          }
        ]
      },
      "{audioId}": {
        "{audioTitle}": [
          {
            "listens": 1,
            "date": "2024-07-08T00:00:00"
          }
        ]
      }
    },
    "total": 3
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array	Indicates if there was an error.
messages	array	Returns the response messages from the back-end.
result	object	Returns the response object containing listensPerAudio and total.
listensPerAudio	object	Object with audio IDs as keys, each mapping to an object where audio names map to an array of objects with listens (number) and date (timestamp).
total	integer	Total count related to the result.
resultInfo	string	Additional information about the result
statusCode	integer	HTTP Status Code of the response.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed