Skip to content
Termly API Docs

Websites

GET

Retrieve all or some of the websites in an account for the specified query. The query has the following JSON shape:

Request

[
  {
    "account_id": "<string>",
    "ids": [
      "<string>"
    ]
  }
]

At least 1 object with an account_id must be provided. If you would like to retrieve all of the websites in an account omit the ids parameter. If ids is sent it must have 1 or more items. Once constructed the object must be URL encoded and be the value for the query parameter.

Paging

All GET requests are subject to paging, please refer to Result Paging for details, and the Paging Parameters Object for configuring the parameters.

Response

The response will look like:

{
  "results": [],
  "errors": [],
  "scrolling": {}
}

results will be 0 or more objects with this shape:

{
  "account_id": "<string>",
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "page_views": <integer>,
  "scan_period": "<enum{'disabled', 'weekly', 'monthly', 'trimonthly'}>",
  "report": {
    "id": "<string>",
    "created_at": "<string>"
  },
  "subdomains": [
    "<string>"
  ],
  "cookie_count": <integer>,
  "cookie_policy_document_id": "<string>",
  "unclassified_cookie_count": <integer>,
  "company": {
    "legal_name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "fax": "<string>",
    "address": "<string>",
    "zip": "<string>",
    "state": "<string>",
    "city": "<string>",
    "country": "<string>"
  },
  "consent_count": <integer>,
  "code_snippet": {
    "banner": "<string>",
    "cookie_preference_button": "<string>"
  },
  "api_key": "<string>"
}
  • account_id unique identifier of the account that owns the website
  • id unique identifier of the website
  • name name of the website
  • url url of the website including http protocol
  • page_views number of page views that this site has had with the termly banner installed
  • scan_period how often the website will be scanned (on of weekly, monthly, trimonthly)
  • report object describing the latest successful scan result
    • id unique identifier for the report
    • created_at timestamp of when the report was created
  • subdomains an array of subdomains that the scanner will scan as well
    • items are strings
  • cookie_count total number of cookies found
  • cookie_policy_document_id unique identifier of the cookie policy document
  • company object containing all the company related information
    • legal_name legal name of the company
    • email public contact email for the company
    • phone public phone number for the company
    • fax company fax number
    • address street address of the company
    • zip zip code for the company
    • state state
    • city city
    • country country
  • consent_count number of users who have consented to cookies
  • code_snippet object that contains JavaScript snippets to install termly on the website
    • banner JavaScript snippet to install the banner on the website
      • Note: The auto blocker is enabled by default with autoBlock=on in the snippet. It may be manually disabled by changing the snippet to autoBlock=off
    • cookie_preference_button JavaScript snippet to install the preferences button on the website
  • api_key WordPress API key of the website

errors will have 0 or more of the error object.

paging is an object that indicates if there are more results to retrieve. Please see paging

Example 1

Request all websites for a given account

Request

GET https://api.termly.io/v1/websites?query=%5B%7B%22account_id%22%3A%20%22acct_1234%22%7D%5D

Query

[
  {
    "account_id": "acct_1234"
  }
]

Response

{
  "results": [
    {
      "account_id": "acct_123",
      "id": "web_123",
      "name": "termly",
      "url": "https://termly.io",
      "page_views": 0,
      "scan_period": "trimonthly",
      "report": {
        "id": "rep_123",
        "created_at": "2021-09-21 01:58:53.721954 UTC"
      },
      "subdomains": [
        "app.termly.io"
      ],
      "cookie_count": 0,
      "cookie_policy_document_id": "doc_123",
      "unclassified_cookie_count": 0,
      "company": {
        "legal_name": "termly",
        "email": "[email protected]",
        "phone": "1112223333",
        "fax": "1112223344",
        "address": "522 W. Riverside Ave.,Suite 4296",
        "zip": "99201",
        "state": "WA",
        "city": "Spokane",
        "country": "USA"
      },
      "consent_count": 0,
      "code_snippet": {
        "banner": "<Javascript code>",
        "cookie_preference_button": "<Javascript code>"
      },
      "api_key": "abcdefg"
    }
  ],
  "errors": [],
  "paging": {
    "next_results": null,
    "previous_results": null
  }
}

Example 2

Multiple accounts and websites in each account and one website cannot be found

Request

GET https://api.termly.io/v1/websites?query=%5B%20%7B%20%22account_id%22%3A%20%22acct_123%22%2C%20%22ids%22%3A%20%5B%22web_123%22%5D%7D%2C%20%7B%22account_id%22%3A%20%22acct_1234%22%2C%20%22ids%22%3A%20%5B%22web_13%22%2C%20%22web_14%22%5D%7D%5D

Query

[
  {
    "account_id": "acct_123",
    "ids": ["web_123"]
  },


  {
    "account_id": "acct_1234",
    "ids": ["web_13", "web_14"]
  }
]

Response

{
  "results": [
    {
      "account_id": "acct_123",
      "id": "web_123",
      "name": "termly",
      "url": "https://termly.io",
      "page_views": 0,
      "scan_period": "trimonthly",
      "report": {
        "id": "rep_123",
        "created_at": "2021-09-21 01:58:53.721954 UTC"
      },
      "subdomains": [
        "app.termly.io"
      ],
      "cookie_count": 0,
      "cookie_policy_document_id": "doc_123",
      "unclassified_cookie_count": 0,
      "company": {
        "legal_name": "termly",
        "email": "[email protected]",
        "phone": "1112223333",
        "fax": "1112223344",
        "address": "522 W. Riverside Ave.,Suite 4296",
        "zip": "99201",
        "state": "WA",
        "city": "Spokane",
        "country": "USA"
      },
      "consent_count": 0,
      "code_snippet": {
        "banner": "<Javascript code>",
        "cookie_preference_button": "<Javascript code>"
      },
      "api_key": "abcdefg"
    },
    {
      "account_id": "acct_1234",
      "id": "web_13",
      "name": "termly 2",
      "url": "https://termly.io",
      "page_views": 0,
      "scan_period": "trimonthly",
      "report": {
        "id": "rep_123",
        "created_at": "2021-09-21 01:58:53.721954 UTC"
      },
      "subdomains": [
        "app.termly.io"
      ],
      "cookie_count": 0,
      "cookie_policy_document_id": "doc_123",
      "unclassified_cookie_count": 0,
      "company": {
        "legal_name": "termly",
        "email": "[email protected]",
        "phone": "1112223333",
        "fax": "1112223344",
        "address": "522 W. Riverside Ave.,Suite 4296",
        "zip": "99201",
        "state": "WA",
        "city": "Spokane",
        "country": "USA"
      },
      "consent_count": 0,
      "code_snippet": {
        "banner": "<Javascript code>",
        "cookie_preference_button": "<Javascript code>"
      },
      "api_key": "hijklmnop"
    }
  ],
  "errors": [
    {
      "error": "object_not_found",
      "account_id": "acct_1234",
      "id": "web_13"
    }
  ],
  "paging": {
    "next_results": null,
    "previous_results": null
  }
}

Example 3

Request wit ids parameter but value is empty array

Request

GET https://api.termly.io/v1/websites?query=%5B%7B%22account_id%22%3A%22acct_123%22%2C%22ids%22%3A%5B%5D%7D%5D

Query

[
  {
    "account_id": "acct_123",
    "ids": []
  }
]

Response

{
  "results": [],
  "errors": [],
  "paging": {
    "next_results": null,
    "previous_results": null
  }
}