{"method":"GET","path":"https://api.revcent.com/v2/url_parameter_sets/{url_parameter_set_id}","summary":"Get A URL Parameter Set","description":"Retrieve the details of a specific URL parameter set. View markdown documentation at https://revcent.com/documentation/markdown/mcp/operation/OverviewUrlParameterSet.md for an in-depth overview of this operation.","operationId":"GetUrlParameterSet","parameters":[{"in":"path","name":"url_parameter_set_id","description":"The URL parameter set ID.","required":true,"schema":{"type":"string","description":"A 20 character URL parameter set ID.","minLength":20,"maxLength":20}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"The API call response code, 1 = Success","type":"integer","enum":[1]}},"title":"APICallResponseInfo","type":"object","additionalProperties":false},{"type":"object","description":"A URL parameter set allows you to define a set of URL parameters that RevCent should save for all visitors and purchases to your stores via RevCent's in house DNS tracking. When creating or modifying a tracking domain, you can attach a URL parameter set to ensure that all URL parameters for that domain are saved when a visitor lands on your site.","additionalProperties":false,"properties":{"created_date_unix":{"description":"The unix timestamp of when the item was created.","type":"integer","format":"unix-time"},"id":{"type":"string","description":"A 20 character URL parameter set ID.","minLength":20,"maxLength":20},"name":{"description":"The URL parameter set name.","type":"string"},"description":{"description":"The URL parameter set description.","type":"string"},"enabled":{"description":"Whether the URL parameter set is currently enabled.","type":"boolean"},"url_parameters":{"type":"array","description":"A list of URL parameters to save. You indicate the URL parameter to save along with the metadata name to save the value as.","items":{"type":"object","additionalProperties":false,"properties":{"url_parameter":{"description":"The URL parameter to save. For example, if the URL parameter is 'utm_source', then RevCent will save the value of the utm_source parameter for all visitors and purchases to your stores via RevCent's in house DNS tracking.","type":"string"},"metadata_name":{"description":"The name to save the URL parameter as in RevCent's metadata. It is common practice to set the metadata_name as the same as the url_parameter. If left empty, RevCent will save the URL parameter value to metadata using the URL parameter as the metadata name. For example, if the URL parameter is 'utm_source', and the metadata_name is left empty, then RevCent will save the value of the utm_source URL parameter to metadata with the metadata name of 'utm_source'. If the URL parameter is 'utm_source', and the metadata_name is set to 'source', then RevCent will save the value of the utm_source URL parameter to the visitors' metadata with the metadata name of 'source'. Recommended to leave empty or set the same as url_parameter.","type":"string"},"default_value":{"description":"The default value to save for the URL parameter if the URL parameter is present in the URL but you wish to save a default value intead of the value in the URL. This is optional. If not provided, RevCent will save the value in the URL. For example, if the URL parameter is 'utm_source', but you want to save the value as 'organic' regardless of the actual utm_source value in the URL, then you would set the default_value to 'organic'. Recommended to leave empty.","type":"string"},"days":{"description":"The number of days to save the URL parameter name/value to a specific visitor, i.e. the cookie age for the visitor for the URL parameter. This is optional. If not provided, RevCent will use the default value of 30 days. Recommended value is 30.","type":"integer"}}}},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time"}}}]}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","enum":[0]},"error_code":{"description":"The specific error code.","type":"string"},"message":{"description":"A human readable description of the error.","type":"string"},"result":{"description":"A description of the API call result.","type":"string"}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}