HTTP Requests

List of all HTTP requests that are made to VWO server for various purposes.

PurposeEndpointRequired paramsDescriptionResponse
Get settingsFilehttps://dev.visualwebsiteoptimizer.com/server-side/settingsaccountId
sdkKey
This is required for fetching the settingsFile required for instantiating the VWO SDK.Status Code: 200
Response: JSON - settingsFile

If sdkKey is not valid, then

Status Code: 400
Response: JSON - {"message":"Invalid api key"}
Track visitorhttps://dev.visualwebsiteoptimizer.com/server-side/track-userVWO sends the essential params like accountId, campaignId, variation assigned, current time, user ID, UUID of user, along with meta information like sdk-name, sdk-version, etc.To send an event to VWO server to track a visitor.Status Code: 200
Empty response
Track Conversionhttps://dev.visualwebsiteoptimizer.com/server-side/track-goalVWO sends the essential params like accountId, campaignId, variation assigned, current time, user ID, UUID of user, goalId and revenue(if revenue goal), along with meta information like sdk-name, sdk-version, etc.To send an event to VWO server to track a conversion. Various metrics are calculated and shown in campaign reports based on count of visitors and conversions.Status Code: 200
Empty response
Custom Dimensionhttps://dev.visualwebsiteoptimizer.com/server-side/pushVWO sends the essential params like accountId, current time, user ID, UUID of user, custom-dimension-key, custom-dimension-value, along with meta information like sdk-name, sdk-version, etc.To categorize and differentiate user. Post-segmentation can be applied on this cutom-dimension to view segmented report data.
Batch Eventshttps://dev.visualwebsiteoptimizer.com/server-side/batch-eventsVWO SDK batches different events like track-user, track-goal, and push and sends to VWO.VWO SDK batches different events and sends them in a single POST call.

If you enable the DEBUG or INFO logs, all such information can be seen there. Read more on how to set log level and customize the logger.

Fetching Settings File

URL - GET https://dev.visualwebsiteoptimizer.com/server-side/settings

Query Params

ParamDescriptionTypeExample
a
(Required)
VWO Account IDNumber12345
i
(Required)
SDK KeyAlphanumericaa87170ad94079aa190bc7c9b85d26zz

Response - JSON - has the account and campaigns configuration. Otherwise the error message.

Example

https://dev.visualwebsiteoptimizer.com/server-side/settings?a=12345&i=aa87170ad94079aa190bc7c9b85d26zz

Tracking a User in a Campaign

URL - GET https://dev.visualwebsiteoptimizer.com/server-side/track-user

Query Params

ParamDescriptionTypeExample
account_id
(Required)
VWO Account IDNumber12345
sId
(Required)
Session ID / Current UtC TimestampNumber1641218854
u
(Required)
32 characters long UUIDAlphanumericO33C4BA1CB0C53CDB32B51AF403B344P
experiment_id
(Required)
VWO Experiment IDNumber10
combination
(Required)
Variation ID in which User got bucketedNumber2
env
(Required)
SDK/environment Key
This is for viewing reports based on project's environment
Alphanumericaa87170ad94079aa190bc7c9b85d26zz
ed
(Required)
For backward compatibilityJSON{"p":"server"}
random
(Required)
For cache bustingFloat0.6375406415765388
sdk
(Optional)
Name of SDK usedStringvwo-node-sdk or
vwo-java-sdk and so on
sdk-v
(Optional)
Version of SDK usedSemver1.30.0

Response - JSON

Example -

https://dev.visualwebsiteoptimizer.com/server-side/track-user?experiment_id=480&combination=1&sId=1641218854&u=O33C4BA1CB0C53CDB32B51AF403B344P&sdk=vwo-node-sdk&sdk-v=1.28.0&account_id=60781&random=0.6375406415765388&ed=%7B%22p%22:%22server%22%7D&env=b243e464740be856d35d4da72c02a15d

Tracking a User Conversion in a campaign

URL - GET https://dev.visualwebsiteoptimizer.com/server-side/track-goal

Query Params

ParamDescriptionTypeExample
account_id
(Required)
VWO Account IDNumber12345
sId
(Required)
Session ID / Current UtC TimestampNumber1641218854
u
(Required)
32 characters long UUIDAlphanumericO33C4BA1CB0C53CDB32B51AF403B344P
experiment_id
(Required)
VWO Experiment IDNumber10
combination
(Required)
Variation ID in which User got bucketedNumber2
goal_id
(Required)
Goal ID of a campaignNumber1
env
(Required)
SDK/environment Key
This is for viewing reports based on project's environment
Alphanumericaa87170ad94079aa190bc7c9b85d26zz
ap
(Required)
PlatformStringserver
random
(Required)
For cache bustingFloat0.6375406415765388
sdk
(Optional)
Name of SDK usedStringvwo-node-sdk or
vwo-java-sdk and so on
sdk-v
(Optional)
Version of SDK usedSemver1.31.0

Response - JSON

Example

https://dev.visualwebsiteoptimizer.com/server-side/track-goal?experiment_id=481&combination=1&sId=1643870500&u=C13C4BA1CB0C53CDB32B51AF403B3352&sdk=vwo-node-sdk&sdk-v=1.32.1&env=aa43e464740be856d35d4da72c02a15d&account_id=12345&random=0.38654106039749414&goal_id=343&ap=servevr

Pushing a Custom Dimension

URL - GET https://dev.visualwebsiteoptimizer.com/server-side/push

Query Params

ParamDesscriptionTypeExample
account_id
(Required)
VWO Account IDNumber12345
sId
(Required)
Session ID / Current UtC TimestampNumber1641218854
u
(Required)
32 characters long UUIDAlphanumericO33C4BA1CB0C53CDB32B51AF403B344P
env
(Required)
SDK/environment Key
This is for viewing reports based on project's environment
Alphanumericaa87170ad94079aa190bc7c9b85d26zz
tagsCustom Dimension DataJSON{"u":{"key":"value"}}
random
(Required)
For cache bustingFloat0.6375406415765388
apPlatformStringserver
sdk
(Optional)
Name of SDK usedStringvwo-node-sdk or
vwo-java-sdk and so on
sdk-v
(Optional)
Version of SDK usedSemver1.30.0

Response - JSON - has the account and campaigns configuration. Otherwise the error message.

Example

https://dev.visualwebsiteoptimizer.com/server-side/push?sId=1643870764&u=4F3FE0FB2FF05CE19233BF181D81DE27&sdk=vwo-node-sdk&sdk-v=1.32.1&env=aa43e464740be856d35d4da72c02a15d&account_id=12345&random=0.1516327177576584&ap=server&tags={"u":{"browser":"chrome"}}&

What’s Next