Skip to main content

List links on a website source



This API is used to list links on a website source.

It'll return a 400/BadRequest error if the following conditions meet:

  • if the source type is not a SOURCE_TYPE_WEBSITE and will return an ERROR_REASON_SOURCE_REQUIRES_A_WEBSITE_TYPE error reason.

It'll return a 404/NotFound error if any requested resource is not found.


Path Parameters

    id stringrequired

    Required. The uuid of the source.

Query Parameters

    url string

    Optional. The URL of the link to filter.

    current_page int32

    Input only. Indicates the current page to shows. Default: 1.

    items_per_page int32

    Input only. Indicates the number of items to shows per page. Default: 1. Max: 100.


A successful response.

    links object[]
  • Array [
  • id string

    Output only. The uuid of the source id of the link.

    url stringrequired

    Required. The url link.

    status string


    Output only. The source status of the link.

    error_infos object[]

    Output only. A list of messages that carry the error infos when link is failed.

  • Array [
  • reason string

    The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

    domain string

    The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "".

    metadata object

    Additional structured details about this error.

    Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.

    property name* string
  • ]
  • ]
  • pagination object
    total_items int32

    Output only. The total numbers of the list in the current pagination.

    items_per_page int32

    Output only. The number of items per page in the current pagination.

    current_page int32

    Output only. The current page in the current pagination.