{
  "url": "https://telipot.com/catalog/capabilities/analytics.properties.streams.list",
  "id": "analytics.properties.streams.list",
  "description": "Data streams of an analytics property, with their measurement ids and domains",
  "platform": "analytics",
  "providers": [
    {
      "slug": "google-analytics",
      "name": "Google Analytics 4"
    }
  ],
  "tasks": 1,
  "taskPages": [
    {
      "id": "google-analytics.properties.streams.list",
      "name": "Data streams of a property with measurement ids and domains",
      "provider": {
        "slug": "google-analytics",
        "name": "Google Analytics 4"
      },
      "capability": "analytics.properties.streams.list",
      "platform": "analytics",
      "kind": "data",
      "tier": "core",
      "identity": "account",
      "identityLabel": "Company account",
      "price": {
        "amount": "Free",
        "state": "free",
        "label": "Free",
        "detail": "Free from the tool",
        "type": "free"
      },
      "providers": 1,
      "retention": "standard",
      "runsOn": "free",
      "live": true,
      "summary": "Lists DataStreams on a property.",
      "method": "GET",
      "path": "/v1beta/properties/{propertyId}/dataStreams",
      "host": "https://analyticsadmin.googleapis.com",
      "docsUrl": "https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1beta/properties.dataStreams/list",
      "auth": {
        "scheme": "oauth",
        "label": "oauth · OAuth 2.0 with PKCE",
        "short": "oauth · OAuth 2.0"
      },
      "scope": "own_account",
      "principal": "organization",
      "requiredScopes": [
        "analytics.readonly"
      ],
      "verification": {
        "state": "none",
        "label": "Not verified yet",
        "detail": "Not checked yet. We test with a real request before we mark it."
      },
      "input": [
        {
          "name": "propertyId",
          "location": "pathParams",
          "type": "string",
          "required": true,
          "constraints": [],
          "note": "The numeric id of a GA4 property, as google-analytics.accounts.summaries returns it after properties/"
        },
        {
          "name": "pageSize",
          "location": "queryParams",
          "type": "integer",
          "required": false,
          "constraints": [
            "1 to 200",
            "default 50"
          ],
          "note": "Streams to return; a page may hold fewer even when more follow"
        },
        {
          "name": "pageToken",
          "location": "queryParams",
          "type": "string",
          "required": false,
          "constraints": [],
          "note": "The nextPageToken of the previous page"
        }
      ],
      "sampleInput": {
        "propertyId": "123456789"
      },
      "inputSchema": {
        "type": "object",
        "properties": {
          "propertyId": {
            "type": "string",
            "description": "The numeric id of a GA4 property, as google-analytics.accounts.summaries returns it after properties/",
            "examples": [
              "123456789"
            ]
          },
          "pageSize": {
            "type": "integer",
            "description": "Streams to return; a page may hold fewer even when more follow",
            "default": 50,
            "minimum": 1,
            "maximum": 200
          },
          "pageToken": {
            "type": "string",
            "description": "The nextPageToken of the previous page"
          }
        },
        "required": [
          "propertyId"
        ],
        "additionalProperties": false
      },
      "output": [
        {
          "name": "dataStreams",
          "type": "object[]",
          "description": "Absent when the property has no stream"
        },
        {
          "name": "nextPageToken",
          "type": "string",
          "description": "Absent on the last page"
        }
      ],
      "outputSchema": {
        "type": "object",
        "properties": {
          "dataStreams": {
            "type": "array",
            "description": "Absent when the property has no stream",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "properties/<property id>/dataStreams/<stream id>"
                },
                "type": {
                  "type": "string",
                  "description": "WEB_DATA_STREAM, ANDROID_APP_DATA_STREAM or IOS_APP_DATA_STREAM"
                },
                "displayName": {
                  "type": "string"
                },
                "createTime": {
                  "type": "string"
                },
                "updateTime": {
                  "type": "string"
                },
                "webStreamData": {
                  "type": "object",
                  "description": "Present for a web stream",
                  "properties": {
                    "measurementId": {
                      "type": "string",
                      "description": "The G- id a page's tag reports to"
                    },
                    "defaultUri": {
                      "type": "string",
                      "description": "The domain being measured"
                    },
                    "firebaseAppId": {
                      "type": "string"
                    }
                  }
                },
                "androidAppStreamData": {
                  "type": "object",
                  "description": "Present for an Android app stream",
                  "properties": {
                    "packageName": {
                      "type": "string"
                    },
                    "firebaseAppId": {
                      "type": "string"
                    }
                  }
                },
                "iosAppStreamData": {
                  "type": "object",
                  "description": "Present for an iOS app stream",
                  "properties": {
                    "bundleId": {
                      "type": "string"
                    },
                    "firebaseAppId": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "nextPageToken": {
            "type": "string",
            "description": "Absent on the last page"
          }
        }
      },
      "example": {
        "file": "examples/google-analytics.properties.streams.list.json",
        "json": {
          "dataStreams": [
            {
              "name": "properties/123456789/dataStreams/9876543210",
              "type": "WEB_DATA_STREAM",
              "displayName": "example.com",
              "createTime": "2024-01-15T10:25:00.000Z",
              "updateTime": "2024-01-15T10:25:00.000Z",
              "webStreamData": {
                "measurementId": "G-EXAMPLE123",
                "defaultUri": "https://www.example.com"
              }
            }
          ]
        }
      },
      "commands": {
        "mode": "run",
        "cli": "telipot run google-analytics.properties.streams.list \\\n  --input-json '{\"propertyId\":\"123456789\"}'",
        "http": "curl https://api.telipot.com/v1/tasks/google-analytics.properties.streams.list/run \\\n  -H \"Authorization: Bearer $TELIPOT_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"propertyId\":\"123456789\"}'",
        "quote": "telipot run google-analytics.properties.streams.list \\\n  --input-json '{\"propertyId\":\"123456789\"}' \\\n  --quote"
      },
      "siblings": []
    }
  ]
}
