World is now on Opti ID! Learn more

manh_nguyen
Apr 1, 2024
  61
(0 votes)

Introducing Optimizely Graph Client and its advantages

Introduction

Optimizely Graph Client was introduced in mid of March 2024 as a lightweight package that mostly supports generating query to our Optimizely Graph service, but you can use that package for your own GraphQL server.

Optimizely Graph Client plays pivotal roles in facilitating seamless interaction with GraphQL APIs and offers distinct advantages for customers seeking simplicity and efficiency. We'll explore how the Optimizely Graph Client eliminates the need for GraphQL expertise by leveraging LINQ expressions and fluent interfaces, ultimately enhancing the user experience and accelerating development phrase.

You could find the documentation about the package for developers on our Dev guide.

Simplifying Query Builder

For some kind of other tools that require you first to write a GraphQL query into a file and then generate it into C# code, this approach needs to re-generate the client file every time you update your GraphQL query.

With our Optimizely Graph Client, one of the primary advantages is its ability to simplify query builder for developers with limited GraphQL knowledge. While other tools require developers to craft GraphQL queries manually, the Optimizely Graph Client reduces the complexity by allowing developers to express their query requirements using familiar LINQ (Language Integrated Query) and chainable methods. This intuitive approach empowers developers to focus on defining their data requirements in a familiar programming paradigm, without the need to delve into the intricacies of GraphQL syntax.

If you were using FIND (Search & Navigation) client packages you could see a very similar syntax to build a search query to Graph service by leveraging LINQ Expressions and fluent interfaces.

An example to express how to build a simple search query on Alloy site:

public class SearchPageController : PageControllerBase<SearchPage>
    {
        private GraphQueryBuilder _queryBuilder;
        public SearchPageController(GraphQueryBuilder queryBuilder)
        {
            _queryBuilder = queryBuilder;
        }

        public ViewResult Index(SearchPage currentPage, string q, string t, string p = "1")
        {
            var query = _queryBuilder
                .OperationName("Alloy_Sample_Query")
                    .ForType<SitePageData>()
                    .Skip((0)
                    .Limit(10)
                    .Fields(x=>x.Name, x=> x.Url, x=> x.MetaTitle, x=> x.MetaDescription)
                    .Total()
                    .Search(q)
                    .FilterForVisitor()
                    .UsingSynonyms()
                    .Facet(x=>x.ContentType.FacetFilters(t));
            var content = query.GetResultAsync<SitePageData>().Result.Content;
            var model = new SearchContentModel(content);
            return View(model);
        }
    }

The GraphQL query should looks like:

query Alloy_Sample_Query {
  SitePageData(
    skip: 0
    limit: 10
    where: { _fulltext: { match: "plan" }, Status: { eq: "Published" } }
  ) {
    items {
      Name
      Url
      MetaDescription
      MetaTitle
    }
    facets {
      ContentType(filters: ["PageData"]) {
        name
        count
      }
    }
    total
  }
}

Dynamic Query Generation

The Optimizely Graph Client excels in dynamically generating GraphQL queries based on user-defined criteria expressed at runtime. This dynamic query generation capability allows for dynamic customization based on user input or changing requirements. Developers can specify filtering, sorting, or other criteria dynamically, leading to more flexible and adaptable queries.

Personalization

By defining query criteria dynamically, developers can fetch targeted data relevant to their requirements. This personalized approach to data retrieval fosters a deeper understanding of user behavior, enabling data-driven decision-making and more effective optimization strategies.

Enhanced Productivity and Efficiency

By eliminating the need for manual GraphQL query scripting, the Optimizely Graph Client significantly enhances productivity and efficiency for developers. You can build your complex query with just a few lines of code. Instead of managing static queries, developers can focus on building flexible query generation mechanisms that can adapt to changing requirements over time and do not need to keep track of all your queries in some script files anymore. Otherwise, with this approach you can make the unit test or integration test easier to use and your code easy to debug.

Conclusion

In conclusion, the Optimizely Graph Client is a compelling choice for customers who are seeking simplicity, efficiency, and seamless integration in their experimentation and optimization endeavors. Optimizely Graph Client empowers developers to interact with Optimizely GraphQL API intuitively, without requiring specialized knowledge of GraphQL syntax. This approach not only enhances productivity and efficiency but also accelerates experimentation workflows, enabling organizations to unlock the full potential of digital optimization with ease.

Looking Ahead

Currently, the source code is publicly available in our Github repository for any contributor. We’re continuously refining and enhancing the functionalities for the package. Your feedback and your ideas are invaluable in this ongoing process. Please do not hesitate to raise issues or create pull requests to our repository.

Apr 01, 2024

Comments

Please login to comment.
Latest blogs
Make Global Assets Site- and Language-Aware at Indexing Time

I had a support case the other day with a question around search on global assets on a multisite. This is the result of that investigation. This co...

dada | Jun 26, 2025

The remote server returned an error: (400) Bad Request – when configuring Azure Storage for an older Optimizely CMS site

How to fix a strange issue that occurred when I moved editor-uploaded files for some old Optimizely CMS 11 solutions to Azure Storage.

Tomas Hensrud Gulla | Jun 26, 2025 |

Enable Opal AI for your Optimizely products

Learn how to enable Opal AI, and meet your infinite workforce.

Tomas Hensrud Gulla | Jun 25, 2025 |

Deploying to Optimizely Frontend Hosting: A Practical Guide

Optimizely Frontend Hosting is a cloud-based solution for deploying headless frontend applications - currently supporting only Next.js projects. It...

Szymon Uryga | Jun 25, 2025

World on Opti ID

We're excited to announce that world.optimizely.com is now integrated with Opti ID! What does this mean for you? New Users:  You can now log in wit...

Patrick Lam | Jun 22, 2025

Avoid Scandinavian Letters in File Names in Optimizely CMS

Discover how Scandinavian letters in file names can break media in Optimizely CMS—and learn a simple code fix to automatically sanitize uploads for...

Henning Sjørbotten | Jun 19, 2025 |