Skip to content

Commit e8598e8

Browse files
committed
update doc
1 parent a97e5f8 commit e8598e8

1 file changed

Lines changed: 28 additions & 28 deletions

File tree

doc/sphinx-guides/source/api/native-api.rst

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5772,6 +5772,34 @@ The fully expanded example above (without environment variables) looks like this
57725772
57735773
curl "https://demo.dataverse.org/api/info/exportFormats"
57745774
5775+
Get Customization File Contents
5776+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5777+
5778+
The Customization API is used to retrieve the analytics-code.html as well as other customization file contents.
5779+
5780+
See also :ref:`web-analytics-code` in the Configuration section of the Installation Guide. :ref:`Branding Your Installation`
5781+
5782+
The Content-Type returned in the header is based on the media type of the file being returned (example: analytics-code.html returns "text/html; charset=UTF-8"
5783+
5784+
Valid types are "homePage", "header", "footer", "style", "analytics", and "logo".
5785+
5786+
A curl example getting the analytics-code
5787+
5788+
.. code-block:: bash
5789+
5790+
export SERVER_URL=https://demo.dataverse.org
5791+
export TYPE=analytics
5792+
5793+
curl -X GET "$SERVER_URL/api/info/settings/customization/$TYPE"
5794+
5795+
The fully expanded example above (without environment variables) looks like this:
5796+
5797+
.. code-block:: bash
5798+
5799+
curl -X GET "https://demo.dataverse.org/api/info/settings/customization/analytics"
5800+
5801+
.. _customization-analytics:
5802+
57755803
.. _metadata-blocks-api:
57765804
57775805
Metadata Blocks
@@ -7703,31 +7731,3 @@ Parameters:
77037731
77047732
``per_page`` Number of results returned per page.
77057733
7706-
7707-
Customization File Contents
7708-
---------------------------
7709-
7710-
The Customization API is used to retrieve the analytics-code.html as well as other customization file contents.
7711-
7712-
See also :ref:`web-analytics-code` in the Configuration section of the Installation Guide. :ref:`Branding Your Installation`
7713-
7714-
The Content-Type returned in the header is based on the media type of the file being returned (example: analytics-code.html returns "text/html; charset=UTF-8"
7715-
7716-
Valid types are "homePage", "header", "footer", "style", "analytics", and "logo".
7717-
7718-
A curl example getting the analytics-code
7719-
7720-
.. code-block:: bash
7721-
7722-
export SERVER_URL=https://demo.dataverse.org
7723-
export TYPE=analytics
7724-
7725-
curl -X GET "$SERVER_URL/api/info/settings/customization/$TYPE"
7726-
7727-
The fully expanded example above (without environment variables) looks like this:
7728-
7729-
.. code-block:: bash
7730-
7731-
curl -X GET "https://demo.dataverse.org/api/info/settings/customization/analytics"
7732-
7733-
.. _customization-analytics:

0 commit comments

Comments
 (0)