User

Download schema

API endpoints to manage user

Get user settings

GET

https://api.funnelflux.pro/v1

/user/settings/

Retrieve a user settings of current or specified user

Get user settings › query Parameters

userId

string

The user's ID for who need to return settings. Optional, if not passed the user ID from 'key' will be taken. Useful if need to request any user settings by id using internal key (edge, reporting)

Get user settings › Responses

The requested user settings

UserSettings

defaultHomepageURL

string · required

URL of default homepage, keep empty for 404 response

Default: null

defaultOfferRedirect

PageRedirectType · enum · required

Default redirect type for offers. See more about types in Page.redirectType description

Enum values:

301

307

meta

umr

defaultLanderRedirect

PageRedirectType · enum · required

Default redirect type for landers. See more about types in Page.redirectType description

Enum values:

301

307

meta

umr

ipAnonymizer

string · enum · required

IP Anonymizer name

Enum values:

disabled

All IPs

EU IPs

defaultCustomDomain

string · required

Default custom domain name from 'customDomains' collection

ThirdPartyKeys

Keys from third parties

savedViews

string[]

object

Custom event number to alias mappings for reporting

Save user settings

PUT

https://api.funnelflux.pro/v1

/user/settings/

Create or update user settings of current user

Save user settings › Request Body

UserSettings

defaultHomepageURL

string · required

URL of default homepage, keep empty for 404 response

Default: null

defaultOfferRedirect

PageRedirectType · enum · required

Default redirect type for offers. See more about types in Page.redirectType description

Enum values:

301

307

meta

umr

defaultLanderRedirect

PageRedirectType · enum · required

Default redirect type for landers. See more about types in Page.redirectType description

Enum values:

301

307

meta

umr

ipAnonymizer

string · enum · required

IP Anonymizer name

Enum values:

disabled

All IPs

EU IPs

defaultCustomDomain

string · required

Default custom domain name from 'customDomains' collection

ThirdPartyKeys

Keys from third parties

savedViews

string[]

object

Custom event number to alias mappings for reporting

Save user settings › Responses

User settings created/updated successfully

No data returned

PUT/user/settings/

curl --request PUT \
  --url https://api.funnelflux.pro/v1/user/settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "defaultHomepageURL": "https://example.com/",
  "defaultOfferRedirect": "301",
  "defaultLanderRedirect": "307",
  "ipAnonymizer": "EU IPs",
  "defaultCustomDomain": "domain1.com",
  "customEventAliases": {
    "1": {
      "alias": "Lead",
      "shortAlias": "Lead"
    },
    "2": {
      "alias": "Complete Registration",
      "shortAlias": "Reg"
    }
  }
}
'

Example Request Body

{
  "defaultHomepageURL": "https://example.com/",
  "defaultOfferRedirect": "301",
  "defaultLanderRedirect": "307",
  "ipAnonymizer": "EU IPs",
  "defaultCustomDomain": "domain1.com",
  "customEventAliases": {
    "1": {
      "alias": "Lead",
      "shortAlias": "Lead"
    },
    "2": {
      "alias": "Complete Registration",
      "shortAlias": "Reg"
    }
  }
}

json

Example Responses

No example specified for this content type

Delete user settings

DELETE

https://api.funnelflux.pro/v1

/user/settings/

Delete user settings of current user

Delete user settings › Responses

User settings deleted successfully

No data returned

Categories Integration

FunnelFlux Assets API

User

Download schema

API endpoints to manage user

Get user settings

GET

https://api.funnelflux.pro/v1

/user/settings/

Retrieve a user settings of current or specified user

Get user settings › query Parameters

userId

string

The user's ID for who need to return settings. Optional, if not passed the user ID from 'key' will be taken. Useful if need to request any user settings by id using internal key (edge, reporting)

Get user settings › Responses

The requested user settings

UserSettings

defaultHomepageURL

string · required

URL of default homepage, keep empty for 404 response

Default: null

defaultOfferRedirect

PageRedirectType · enum · required

Default redirect type for offers. See more about types in Page.redirectType description

Enum values:

301

307

meta

umr

defaultLanderRedirect

PageRedirectType · enum · required

Default redirect type for landers. See more about types in Page.redirectType description

Enum values:

301

307

meta

umr

ipAnonymizer

string · enum · required

IP Anonymizer name

Enum values:

disabled

All IPs

EU IPs

defaultCustomDomain

string · required

Default custom domain name from 'customDomains' collection

ThirdPartyKeys

Keys from third parties

savedViews

string[]

object

Custom event number to alias mappings for reporting

Save user settings

PUT

https://api.funnelflux.pro/v1

/user/settings/

Create or update user settings of current user

Save user settings › Request Body

UserSettings

defaultHomepageURL

string · required

URL of default homepage, keep empty for 404 response

Default: null

defaultOfferRedirect

PageRedirectType · enum · required

Default redirect type for offers. See more about types in Page.redirectType description

Enum values:

301

307

meta

umr

defaultLanderRedirect

PageRedirectType · enum · required

Default redirect type for landers. See more about types in Page.redirectType description

Enum values:

301

307

meta

umr

ipAnonymizer

string · enum · required

IP Anonymizer name

Enum values:

disabled

All IPs

EU IPs

defaultCustomDomain

string · required

Default custom domain name from 'customDomains' collection

ThirdPartyKeys

Keys from third parties

savedViews

string[]

object

Custom event number to alias mappings for reporting

Save user settings › Responses

User settings created/updated successfully

No data returned

PUT/user/settings/

curl --request PUT \
  --url https://api.funnelflux.pro/v1/user/settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "defaultHomepageURL": "https://example.com/",
  "defaultOfferRedirect": "301",
  "defaultLanderRedirect": "307",
  "ipAnonymizer": "EU IPs",
  "defaultCustomDomain": "domain1.com",
  "customEventAliases": {
    "1": {
      "alias": "Lead",
      "shortAlias": "Lead"
    },
    "2": {
      "alias": "Complete Registration",
      "shortAlias": "Reg"
    }
  }
}
'

Example Request Body

{
  "defaultHomepageURL": "https://example.com/",
  "defaultOfferRedirect": "301",
  "defaultLanderRedirect": "307",
  "ipAnonymizer": "EU IPs",
  "defaultCustomDomain": "domain1.com",
  "customEventAliases": {
    "1": {
      "alias": "Lead",
      "shortAlias": "Lead"
    },
    "2": {
      "alias": "Complete Registration",
      "shortAlias": "Reg"
    }
  }
}

json

Example Responses

No example specified for this content type

Delete user settings

DELETE

https://api.funnelflux.pro/v1

/user/settings/

Delete user settings of current user

Delete user settings › Responses

User settings deleted successfully

No data returned

Categories Integration