Scroll down to learn more

Documentation Center

Welcome to Opinum Documentation Center. You find here all the content you need to enjoy your data.

Search Results for

    Show / Hide Table of Contents

    Query samples

    Considering the schema sample, here are some sample queries:

    #Get a customer name from it's Id \n
    query {
        Customers @where(Node: "Id = 123") {
            Name
        }
    }
    
    #Get the list of active delivery points by user in year 2023 \n
    query {
        Customers {
            Id 
            Name 
            DeliveryPoints @where(
                Node: "IsActive = 1", 
                Relation: "ContractStart >= '2023' AND OPTIONAL(ContractEnd) < '2024'") 
                { 
                    Ean 
                }
            }
    }
    
    #Get the list 'Consumption*' variable Ids in region 'region1' \n
    query {
        Meters @where(Node: "Region = 'region1'") {
            Sources { 
                Variables @where(Node: "Name STARTS WITH 'Consumption'") {
                    Id
                } 
            }
        }
    }
    
    #Get the full description of all sources belonging to meters and sub-meters attached to delivery point key = 'dp1' \n
    query {
        DeliveryPoints @where(Node: "Key = 'dp1'") {
            Sources { 
                Id 
                Name 
                SerialNumber 
                GatewayId 
                GatewayTypeId 
                GatewayType 
                MeterAddress 
                EanNumber 
                MeterNumber 
                Localisation 
                Description 
                EnergyTypeId 
                EnergyType 
                EnergyUsageId 
                EnergyUsage 
                SourceTypeId 
                SourceType 
                SiteId 
                TimeZoneId 
                Variables {
                    Id 
                    Name 
                    Class 
                    ReadOnly 
                    SourceId 
                    IsDefault 
                    Granularity 
                    GranularityTimeBase 
                    UnitId 
                    UnitSymbol 
                    PropertyBag 
                    MappingConfig 
                    LastModifiedUtc 
                    QuantityType
                }
            } 
        }
    }
    

    Developer Center

    User manual API Swagger Github
    © Opinum 2025  -   www.opinum.com

    Follow us

    Linkedin Twitter Youtube Facebook