{"method":"GET","path":"https://api.revcent.com/v2/tracking_domains","summary":"Get Tracking Domains","description":"Returns a list of tracking domains. View markdown documentation at https://revcent.com/documentation/markdown/mcp/operation/OverviewTrackingDomain.md for an in-depth overview of this operation.","operationId":"GetTrackingDomains","parameters":[{"description":"A limit on the number of objects to be returned. Limit can range between 1 and 25, and the default is 25.","in":"query","name":"limit","required":true,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":25},"style":"form"},{"description":"Used for pagination, i.e. to skip to specific page of results.","in":"query","name":"page","required":true,"schema":{"type":"integer","format":"int32"},"style":"form"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"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":"API call response code.","type":"integer","format":"int32","enum":[1]},"current_count":{"description":"The current number of items in the results.","type":"integer"},"current_page":{"description":"The current page for the items in the results.","type":"integer"},"results":{"items":{"type":"object","description":"Utilize a tracking domain with custom DNS and free SSL, enabling first-party cookies required for accurate visitor tracking, especially across domains. Once a domain is properly set up and SSL issued, you will have access to RevCent's in-house DNS tracking, enabling you to have the most accurate conversion metrics found anywhere.","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 tracking domain ID.","minLength":20,"maxLength":20},"name":{"description":"The user friendly name.","type":"string"},"description":{"description":"The tracking domain description.","type":"string"},"enabled":{"description":"Whether the tracking domain is currently enabled.","type":"boolean"},"domain":{"description":"The root domain associated with the tracking domain. Cannot be modified once a tracking domain is created. Used for issuing SSL.","type":"string"},"url_parameter_sets":{"type":"array","description":"An array of URL parameter sets associated with the tracking domain. It is recommended to create URL parameter set(s) to share URL parameters across multiple tracking domains instead of manually adding URL parameters to each tracking domain using the url_parameters property. By creating URL parameter sets and associating them with tracking domains, you can easily manage URL parameters in one place and have them apply to multiple tracking domains. If you have specific URL parameters that only apply to a single tracking domain, you can add those URL parameters directly to the tracking domain using the url_parameters property.","items":{"type":"string","description":"A 20 character URL parameter set ID.","minLength":20,"maxLength":20}},"url_parameters":{"type":"array","description":"A list of URL parameters to save. This is a manual way to add URL parameters to save for the specific tracking domain without creating a URL parameter set. You indicate the URL parameter to save along with the metadata name to save the value as. Recommended to use URL parameter sets instead of this property for better organization and management of URL parameters across multiple tracking domains.","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 or set a default value that fits your use case.","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, but can be set higher or lower based on your use case and how long you wish to track the URL parameter for each visitor.","type":"integer"}}}},"a_records":{"type":"array","description":"An array of A records to add to your domain's DNS in order to properly initialize SSL and route traffic for the tracking endpoints. These records are provided upon creating a tracking domain via the CreateTrackingDomain operation.","items":{"type":"object","additionalProperties":false,"properties":{"name":{"description":"The A record name.","type":"string","enum":["rctrk","portal","rcacp"]},"value":{"description":"The A record value.","type":"string"}}}},"ssl":{"type":"object","additionalProperties":false,"description":"The SSL status and information for the tracking domain. Read Only.","properties":{"status":{"description":"The SSL status for the tracking domain. Indicates the current status of the SSL and CNAME record availability.\nNOT_INITIALIZED: Have not begun the initialization of the SSL. Please run the initializeTrackingDomainSSL operation.\nPENDING_VALIDATION: The SSL initialization has begun and RevCent is awaiting CNAME verification.\nVALIDATION_TIMED_OUT: The system timed out attempting to validate your CNAME records. Please ensure you have placed the proper CNAME records in your domains' DNS.\nISSUED: The CNAME records have been verified and the SSL certificate has been successfully issued. DNS initialization can begin.\nFAILED: The SSL issuance has failed. Please use the resetTrackingDomainSSL operation to try again.","type":"string","enum":["NOT_INITIALIZED","PENDING_VALIDATION","VALIDATION_TIMED_OUT","ISSUED","FAILED"]},"cname_records":{"type":"array","description":"An array of CNAME records to add to your domain's DNS in order to issue SSL for the tracking domain. These records are provided once you have initialized the SSL setup for the tracking domain using the initializeTrackingDomainSSL operation.","items":{"type":"object","additionalProperties":false,"properties":{"name":{"description":"The CNAME record name.","type":"string"},"value":{"description":"The CNAME record value.","type":"string"}}}}}},"dns":{"type":"object","additionalProperties":false,"description":"The DNS status and information for the tracking domain. Read Only.","properties":{"status":{"description":"The DNS status for the tracking domain. Indicates the current status of the DNS tracking and A record availability.\nAWAITING_SSL: Waiting for you to complete the SSL setup resulting in an ssl status of 'ISSUED'.\nNOT_INITIALIZED: Have not begun the initialization of the DNS. Please run the initializeTrackingDomainDNS operation.\nPENDING: The DNS initialization is in progress and RevCent is creating proper A record endpoints.\nCOMPLETE: The DNS tracking setup is complete and ready to be used. Add the provided A records to your domains' DNS.","type":"string","enum":["AWAITING_SSL","NOT_INITIALIZED","PENDING","COMPLETE"]}}},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time"}}},"type":"array"},"total_count":{"description":"The total number of items found given the date_start and date_end query parameters.","type":"integer"},"total_pages":{"description":"The total number of pages given the date_start, date_end and limit query parameters.","type":"integer"}},"type":"object","additionalProperties":false}}},"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."}}}