Enable template analytics setting

This API endpoint enables or disables template analytics settings for a partner application. Template analytics must be enabled before you can retrieve analytics data using the GET template analytics API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request Parameters

KeyDescriptionValueTypeRequired/OptionalConstraints
AuthorizationAccess Token for the application{{PARTNER_APP_TOKEN}}StringRequiredShould be a valid Partner App Access Token
APP_IDApp ID to fetch the access token{{APP_ID}}StringRequiredThe ID should be a valid app ID of Gupshup
enableFlag to enable template analytics settingTrue/FalseBooleanRequired
enableOnUiFlag to enable template analytics setting on UITrue/FalseBooleanOptional

Sample Request

curl --location --request POST '{{BASE_URL}}/partner/app/{{APP_ID}}/template/analytics' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'enable=true' \
--data-urlencode 'enableOnUi=true'

Sample Response

{
    "status": "success"
}

Status Codes

Status CodeResponseComments
Success
200{ "status": "success" }Successful response
Error
400{ "status": "error", "message": "Bad Request" }Bad request
429{ "status": "error", "message": "Too Many Requests" }10 Requests per Minute
500{ "status": "error", "message": "Internal server error. Please try again later and If Issue still persist than contact Gupshup Dev Support" }For any Internal Error
401{ "status": "error", "message": "Unauthorised access to the resource. Please review request parameters and headers and retry" }Inavalid/Missing Token or appId.

Path Params
string
required

Unique identifier of the app.

Form Data
boolean
required

flag to enable template analytics on Meta

boolean

flag to enable template analytics on UI.

optional(Default: false)

Headers
string
required

Your app token, please refer Get access token api to get the token from partner documentation.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json