1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getWebAnalyticsSites
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.getWebAnalyticsSites

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleWebAnalyticsSites = cloudflare.getWebAnalyticsSites({
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
        orderBy: "host",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_web_analytics_sites = cloudflare.get_web_analytics_sites(account_id="023e105f4ecef8ad9ca31a8372d0c353",
        order_by="host")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.LookupWebAnalyticsSites(ctx, &cloudflare.LookupWebAnalyticsSitesArgs{
    			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
    			OrderBy:   pulumi.StringRef("host"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleWebAnalyticsSites = Cloudflare.GetWebAnalyticsSites.Invoke(new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
            OrderBy = "host",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.CloudflareFunctions;
    import com.pulumi.cloudflare.inputs.GetWebAnalyticsSitesArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var exampleWebAnalyticsSites = CloudflareFunctions.getWebAnalyticsSites(GetWebAnalyticsSitesArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .orderBy("host")
                .build());
    
        }
    }
    
    variables:
      exampleWebAnalyticsSites:
        fn::invoke:
          function: cloudflare:getWebAnalyticsSites
          arguments:
            accountId: 023e105f4ecef8ad9ca31a8372d0c353
            orderBy: host
    

    Using getWebAnalyticsSites

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWebAnalyticsSites(args: GetWebAnalyticsSitesArgs, opts?: InvokeOptions): Promise<GetWebAnalyticsSitesResult>
    function getWebAnalyticsSitesOutput(args: GetWebAnalyticsSitesOutputArgs, opts?: InvokeOptions): Output<GetWebAnalyticsSitesResult>
    def get_web_analytics_sites(account_id: Optional[str] = None,
                                max_items: Optional[int] = None,
                                order_by: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetWebAnalyticsSitesResult
    def get_web_analytics_sites_output(account_id: Optional[pulumi.Input[str]] = None,
                                max_items: Optional[pulumi.Input[int]] = None,
                                order_by: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetWebAnalyticsSitesResult]
    func LookupWebAnalyticsSites(ctx *Context, args *LookupWebAnalyticsSitesArgs, opts ...InvokeOption) (*LookupWebAnalyticsSitesResult, error)
    func LookupWebAnalyticsSitesOutput(ctx *Context, args *LookupWebAnalyticsSitesOutputArgs, opts ...InvokeOption) LookupWebAnalyticsSitesResultOutput

    > Note: This function is named LookupWebAnalyticsSites in the Go SDK.

    public static class GetWebAnalyticsSites 
    {
        public static Task<GetWebAnalyticsSitesResult> InvokeAsync(GetWebAnalyticsSitesArgs args, InvokeOptions? opts = null)
        public static Output<GetWebAnalyticsSitesResult> Invoke(GetWebAnalyticsSitesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWebAnalyticsSitesResult> getWebAnalyticsSites(GetWebAnalyticsSitesArgs args, InvokeOptions options)
    public static Output<GetWebAnalyticsSitesResult> getWebAnalyticsSites(GetWebAnalyticsSitesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudflare:index/getWebAnalyticsSites:getWebAnalyticsSites
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    Identifier
    MaxItems int
    Max items to fetch, default: 1000
    OrderBy string
    The property used to sort the list of results. Available values: "host", "created".
    AccountId string
    Identifier
    MaxItems int
    Max items to fetch, default: 1000
    OrderBy string
    The property used to sort the list of results. Available values: "host", "created".
    accountId String
    Identifier
    maxItems Integer
    Max items to fetch, default: 1000
    orderBy String
    The property used to sort the list of results. Available values: "host", "created".
    accountId string
    Identifier
    maxItems number
    Max items to fetch, default: 1000
    orderBy string
    The property used to sort the list of results. Available values: "host", "created".
    account_id str
    Identifier
    max_items int
    Max items to fetch, default: 1000
    order_by str
    The property used to sort the list of results. Available values: "host", "created".
    accountId String
    Identifier
    maxItems Number
    Max items to fetch, default: 1000
    orderBy String
    The property used to sort the list of results. Available values: "host", "created".

    getWebAnalyticsSites Result

    The following output properties are available:

    AccountId string
    Identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    Results List<GetWebAnalyticsSitesResult>
    The items returned by the data source
    MaxItems int
    Max items to fetch, default: 1000
    OrderBy string
    The property used to sort the list of results. Available values: "host", "created".
    AccountId string
    Identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    Results []GetWebAnalyticsSitesResult
    The items returned by the data source
    MaxItems int
    Max items to fetch, default: 1000
    OrderBy string
    The property used to sort the list of results. Available values: "host", "created".
    accountId String
    Identifier
    id String
    The provider-assigned unique ID for this managed resource.
    results List<GetWebAnalyticsSitesResult>
    The items returned by the data source
    maxItems Integer
    Max items to fetch, default: 1000
    orderBy String
    The property used to sort the list of results. Available values: "host", "created".
    accountId string
    Identifier
    id string
    The provider-assigned unique ID for this managed resource.
    results GetWebAnalyticsSitesResult[]
    The items returned by the data source
    maxItems number
    Max items to fetch, default: 1000
    orderBy string
    The property used to sort the list of results. Available values: "host", "created".
    account_id str
    Identifier
    id str
    The provider-assigned unique ID for this managed resource.
    results Sequence[GetWebAnalyticsSitesResult]
    The items returned by the data source
    max_items int
    Max items to fetch, default: 1000
    order_by str
    The property used to sort the list of results. Available values: "host", "created".
    accountId String
    Identifier
    id String
    The provider-assigned unique ID for this managed resource.
    results List<Property Map>
    The items returned by the data source
    maxItems Number
    Max items to fetch, default: 1000
    orderBy String
    The property used to sort the list of results. Available values: "host", "created".

    Supporting Types

    GetWebAnalyticsSitesResult

    AutoInstall bool
    If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
    Created string
    Rules List<GetWebAnalyticsSitesResultRule>
    A list of rules.
    Ruleset GetWebAnalyticsSitesResultRuleset
    SiteTag string
    The Web Analytics site identifier.
    SiteToken string
    The Web Analytics site token.
    Snippet string
    Encoded JavaScript snippet.
    AutoInstall bool
    If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
    Created string
    Rules []GetWebAnalyticsSitesResultRule
    A list of rules.
    Ruleset GetWebAnalyticsSitesResultRuleset
    SiteTag string
    The Web Analytics site identifier.
    SiteToken string
    The Web Analytics site token.
    Snippet string
    Encoded JavaScript snippet.
    autoInstall Boolean
    If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
    created String
    rules List<GetWebAnalyticsSitesResultRule>
    A list of rules.
    ruleset GetWebAnalyticsSitesResultRuleset
    siteTag String
    The Web Analytics site identifier.
    siteToken String
    The Web Analytics site token.
    snippet String
    Encoded JavaScript snippet.
    autoInstall boolean
    If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
    created string
    rules GetWebAnalyticsSitesResultRule[]
    A list of rules.
    ruleset GetWebAnalyticsSitesResultRuleset
    siteTag string
    The Web Analytics site identifier.
    siteToken string
    The Web Analytics site token.
    snippet string
    Encoded JavaScript snippet.
    auto_install bool
    If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
    created str
    rules Sequence[GetWebAnalyticsSitesResultRule]
    A list of rules.
    ruleset GetWebAnalyticsSitesResultRuleset
    site_tag str
    The Web Analytics site identifier.
    site_token str
    The Web Analytics site token.
    snippet str
    Encoded JavaScript snippet.
    autoInstall Boolean
    If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.
    created String
    rules List<Property Map>
    A list of rules.
    ruleset Property Map
    siteTag String
    The Web Analytics site identifier.
    siteToken String
    The Web Analytics site token.
    snippet String
    Encoded JavaScript snippet.

    GetWebAnalyticsSitesResultRule

    Created string
    Host string
    The hostname the rule will be applied to.
    Id string
    The Web Analytics rule identifier.
    Inclusive bool
    Whether the rule includes or excludes traffic from being measured.
    IsPaused bool
    Whether the rule is paused or not.
    Paths List<string>
    The paths the rule will be applied to.
    Priority double
    Created string
    Host string
    The hostname the rule will be applied to.
    Id string
    The Web Analytics rule identifier.
    Inclusive bool
    Whether the rule includes or excludes traffic from being measured.
    IsPaused bool
    Whether the rule is paused or not.
    Paths []string
    The paths the rule will be applied to.
    Priority float64
    created String
    host String
    The hostname the rule will be applied to.
    id String
    The Web Analytics rule identifier.
    inclusive Boolean
    Whether the rule includes or excludes traffic from being measured.
    isPaused Boolean
    Whether the rule is paused or not.
    paths List<String>
    The paths the rule will be applied to.
    priority Double
    created string
    host string
    The hostname the rule will be applied to.
    id string
    The Web Analytics rule identifier.
    inclusive boolean
    Whether the rule includes or excludes traffic from being measured.
    isPaused boolean
    Whether the rule is paused or not.
    paths string[]
    The paths the rule will be applied to.
    priority number
    created str
    host str
    The hostname the rule will be applied to.
    id str
    The Web Analytics rule identifier.
    inclusive bool
    Whether the rule includes or excludes traffic from being measured.
    is_paused bool
    Whether the rule is paused or not.
    paths Sequence[str]
    The paths the rule will be applied to.
    priority float
    created String
    host String
    The hostname the rule will be applied to.
    id String
    The Web Analytics rule identifier.
    inclusive Boolean
    Whether the rule includes or excludes traffic from being measured.
    isPaused Boolean
    Whether the rule is paused or not.
    paths List<String>
    The paths the rule will be applied to.
    priority Number

    GetWebAnalyticsSitesResultRuleset

    Enabled bool
    Whether the ruleset is enabled.
    Id string
    The Web Analytics ruleset identifier.
    ZoneName string
    ZoneTag string
    The zone identifier.
    Enabled bool
    Whether the ruleset is enabled.
    Id string
    The Web Analytics ruleset identifier.
    ZoneName string
    ZoneTag string
    The zone identifier.
    enabled Boolean
    Whether the ruleset is enabled.
    id String
    The Web Analytics ruleset identifier.
    zoneName String
    zoneTag String
    The zone identifier.
    enabled boolean
    Whether the ruleset is enabled.
    id string
    The Web Analytics ruleset identifier.
    zoneName string
    zoneTag string
    The zone identifier.
    enabled bool
    Whether the ruleset is enabled.
    id str
    The Web Analytics ruleset identifier.
    zone_name str
    zone_tag str
    The zone identifier.
    enabled Boolean
    Whether the ruleset is enabled.
    id String
    The Web Analytics ruleset identifier.
    zoneName String
    zoneTag String
    The zone identifier.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi