Traffic filter management.
Retrieve a traffic filter by its id
Retrieve a traffic filter by its id
query Parameters
apiKeyAn authorized api key
idTrafficFilterRetrieve a traffic filter by its id › Responses
The requested traffic filter
idTrafficFilter64 bits integer id of the traffic filter
trafficFilterNameTraffic filter's name. 255 characters max.
filterTypefilterEntriesThe list of entries to filter against. If filterType = ipRanges, then each entry of the list must be formatted as 'rangeStart, rangeEnd', with a comma to separate the range's start and end. If filter type = knownBotsAndSpiders, then this list must be empty.
redirectToURLIf set to an actual URL, then the filtered traffic is also redirected to that URL instead of flowing in the funnel
isEnabledRetrieve a traffic filter by its name
Retrieve a traffic filter by its name
query Parameters
apiKeyAn authorized api key
nameRetrieve a traffic filter by its name › Responses
The requested traffic filter
idTrafficFilter64 bits integer id of the traffic filter
trafficFilterNameTraffic filter's name. 255 characters max.
filterTypefilterEntriesThe list of entries to filter against. If filterType = ipRanges, then each entry of the list must be formatted as 'rangeStart, rangeEnd', with a comma to separate the range's start and end. If filter type = knownBotsAndSpiders, then this list must be empty.
redirectToURLIf set to an actual URL, then the filtered traffic is also redirected to that URL instead of flowing in the funnel
isEnabledRetrieve all traffic filters with the specified status
Retrieve all traffic filters with the specified status
query Parameters
apiKeyAn authorized api key
statusRetrieve all traffic filters with the specified status › Responses
List of traffic filters with the specified status
idTrafficFilter64 bits integer id of the traffic filter
trafficFilterNameTraffic filter's name. 255 characters max.
filterTypefilterEntriesThe list of entries to filter against. If filterType = ipRanges, then each entry of the list must be formatted as 'rangeStart, rangeEnd', with a comma to separate the range's start and end. If filter type = knownBotsAndSpiders, then this list must be empty.
redirectToURLIf set to an actual URL, then the filtered traffic is also redirected to that URL instead of flowing in the funnel
isEnabledUpdate an existing traffic filter
Update an existing traffic filter. The id cannot be changed.
query Parameters
apiKeyAn authorized api key
Update an existing traffic filter › Request Body
idTrafficFilter64 bits integer id of the traffic filter
trafficFilterNameTraffic filter's name. 255 characters max.
filterTypefilterEntriesThe list of entries to filter against. If filterType = ipRanges, then each entry of the list must be formatted as 'rangeStart, rangeEnd', with a comma to separate the range's start and end. If filter type = knownBotsAndSpiders, then this list must be empty.
redirectToURLIf set to an actual URL, then the filtered traffic is also redirected to that URL instead of flowing in the funnel
isEnabledUpdate an existing traffic filter › Responses
Traffic filter updated successfully
Create a new traffic filter
Create a new traffic filter
query Parameters
apiKeyAn authorized api key
Create a new traffic filter › Request Body
idTrafficFilter64 bits integer id of the traffic filter
trafficFilterNameTraffic filter's name. 255 characters max.
filterTypefilterEntriesThe list of entries to filter against. If filterType = ipRanges, then each entry of the list must be formatted as 'rangeStart, rangeEnd', with a comma to separate the range's start and end. If filter type = knownBotsAndSpiders, then this list must be empty.
redirectToURLIf set to an actual URL, then the filtered traffic is also redirected to that URL instead of flowing in the funnel
isEnabledCreate a new traffic filter › Responses
Traffic filter created successfully
Apply a traffic filter retroactively to existing visits
Apply a traffic filter retroactively to existing visits
query Parameters
apiKeyAn authorized api key
Apply a traffic filter retroactively to existing visits › Responses
Filter applied retroactively