Creates an app integration analytics

Creates a new app integration analytics.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

Provides a data transfer object for the Analytics integration which is used for command requests.

appIntegrationIdstring · min: 1Required

This is used to associate this configuration with a specific integration instance.

trackingIdstring · min: 1Required

This ID is used to track and associate events/data with a specific analytics property or project.

apiKeystring · min: 1Required

This is usually embedded in the frontend to initialize and send data to the analytics platform.

apiSecretstring · nullableOptional

Gets or sets the API secret or verification URL used to authorize or validate requests from the Jframework.

metadatastring · nullableOptional

This can include environment-specific data, custom flags, or platform-specific information.

accountConfigNotesstring · nullableOptional

Gets or sets any additional notes or identifiers related to the account or setup that manages this Analytics configuration.

isDefaultbooleanOptional

Flag to indicate if the analytics integration is the default. By default, it is false.

statusstring · enumOptional

This enum is used to define the common status of an object in JFW.

Supported values:

• Inactive - In case of JFW object's status being inactive.
• Active - In case of JFW object's status being active

Possible values:

Responses

201

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/app-integrations/analytics

HTTPcURLJavaScriptPython

POST /api/v1/app-integrations/analytics HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 289

{
  "appIntegrationId": "sApKpllz4sAplsmzha",
  "trackingId": "UA-98765432-1",
  "apiKey": "AIzaSyD-EXAMPLE-KEY-1234567890",
  "apiSecret": "s3cr3tV@lu3",
  "metadata": "{\"env\":\"production\",\"platform\":\"web\"}",
  "accountConfigNotes": "Google Analytics for main website",
  "isDefault": true,
  "status": "Active"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "appIntegration": {
      "type": "PaymentGateway",
      "name": "Stripe",
      "domain": "https://stripe.com",
      "description": "Stripe payment gateway",
      "logoURL": null,
      "status": "Active",
      "id": "sApKpllz4sAplsmzha"
    },
    "trackingId": "G-XXXXXXX",
    "apiKey": "AIzaS*************",
    "apiSecret": "SECRET_KEY",
    "metadata": "Environment=Production;Region=US",
    "accountConfigNotes": "Google Analytics 4 setup for main website",
    "isDefault": false,
    "status": "Inactive",
    "id": "sApKpllz4sAplsmzha",
    "createdDate": "2026-01-26T08:03:23.57873+07:00"
  },
  "errors": []
}