Retrieving Google Analytics 4 Configurations

Retrieving All Google Analytics 4 Configurations

Using the GET method, you can retrieve your Google Analytics 4 Configurations.

GET https://edgeapi.marchex.io/marketingedge/v5/api/IntegrationConfigurations/GoogleAnalytics4

Results will be paged given the possibility of a large result set, so paging options can also be added to the request. For additional information please see our Paging Documentation

{
  "paging": {
    "pageNumber": 1,
    "pageSize": 1000,
    "total": 1
  },
  "results": [
    {
      "integration_configuration_id": "ffa83516-5205-4959-a367-a10e58bd842c",
      "configuration_name": "GoogleAnalytics4 Integration Name",
      "type": "GoogleAnalytics4",
      "configuration": {
        "measurement_id": "cd485652-9a35-437a-befb-0312c98cd829",
        "api_secret": "secret-key"
      },
      "config_data": {
        "session_based_dni_upload_criteria": "All",
        "events": [
          {
            "name": "Name",
            "call_criteria": "AllMatchedCalls",
            "min_duration_value": 0
          }
        ],
        "event_parameters": [
          {
            "name": "Name",
            "static_value": true,
            "value": "1"
          }
        ],
        "user_parameters": [
          {
            "name": "Name",
            "static_value": true,
            "value": "1"
          }
        ]
      },
      "status": "enabled",
      "domain_access": {
        "billing_groups": [
          "4455",
          "4456"
        ],
        "group_owners": [
          "33344",
          "44433"
        ]
      },
      "created_datetime": "2023-04-06T13:35:07.923Z",
      "modified_datetime": "2023-04-06T13:35:07.923Z"
    },
    {
      "integration_configuration_id": "998831b4-5ff0-486c-bc06-4a2624bd4166",
      "configuration_name": "GoogleAnalytics4 Integration Name",
      "type": "GoogleAnalytics4",
      "configuration": {
        "measurement_id": "32bdce35-5a1a-47ea-8f58-c5fba53a685e",
        "api_secret": "secret-key"
      },
      "config_data": {
        "session_based_dni_upload_criteria": "All",
        "events": [
          {
            "name": "Name",
            "call_criteria": "AllMatchedCalls",
            "min_duration_value": 0
          }
        ],
        "event_parameters": [
          {
            "name": "Name",
            "static_value": true,
            "value": "1"
          }
        ],
        "user_parameters": [
          {
            "name": "Name",
            "static_value": true,
            "value": "1"
          }
        ]
      },
      "status": "enabled",
      "domain_access": {
        "billing_groups": [
          "1234",
          "2345"
        ],
        "group_owners": [
          "34343",
          "43434"
        ]
      },
      "created_datetime": "2023-04-06T13:35:07.923Z",
      "modified_datetime": "2023-04-06T13:35:07.923Z"
    }
  ]
}

Retrieving Google Analytics 4 Configurations by ID

Using the GET method, you can retrieve your Google Analytics 4 Configurations.

GET https://edgeapi.marchex.io/marketingedge/v5/api/IntegrationConfigurations/GoogleAnalytics4/

Results will be paged given the possibility of a large result set, so paging options can also be added to the request. For additional information please see our Paging Documentation. See above for example of response.


Searching for a Google Analytics 4 Configuration

Using the GET method, you can retrieve your Google Analytics 4 Configurations.

GET (https://edgeapi.marchex.io/marketingedge/v5/api/IntegrationConfigurations/GoogleAnalytics4<query_string_params>)

Available query string parameters include:

  • name
  • measurementId

Results will be paged given the possibility of a large result set, so paging options can also be added to the request. For additional information please see our Paging Documentation. See above for example of response.


Fields that are returned when retrieving a GA4 Integration Configuration

ParameterTypeDescription
integration_configuration_idstring
configuration_namestring
typestring
configuration -> measurement_idstring
configuration -> api_secretstring
config_data -> session_based_dni_upload_criteriastring- All
- Session-Matched
- Google Client ID
eventsarrayArray of Events
Min = 1
Max = 10
events -> namestring
events -> call_criteriastring- All Matched Calls
- Min Duration
- Call Tag
events -> min_duration_valueint
events -> call_tagstringcall_tag_id
event_parametersarrayArray of Event_Parameters
Min = 0
Max = 25
event_parameters -> namestring
event_parameters -> static_valuebooleantrue, false
event_parameters -> valuestringstatic = true, user provided value
static = false, see below for valid options
user_parametersarrayArray of User_Parameters
Min = 0
Max = 25
user_parameters -> namestring
user_parameters -> static_valuebooleantrue, false
user_parameters -> valuestringstatic = true, user provided value
static = false, see below for valid options
statusstring
domain_access -> billing_groupsarrayArray of billing_group_id
domain_access -> group_ownersarrayArray of group_owner_id