Data Contract

urn:datacontract:user:creation Data Contract Specification v1.2.0

Info

Information about the data contract

Title
Aggregated User Creation
Version
0.0.1
Status
active
Description
Aggregated user creation events since 2024-01-01.

Servers

Servers of the data contract

  • Server
    production
    Environment
    prod
    Type
    bigquery
    Project
    prj-cld-prd-warehouse-1f51
    Dataset
    kpis_v1
    Description
    One dataset per model.

Terms

Terms and conditions of the data contract

Usage
Data can be used for reports, analytics and machine learning use cases.
Limitations
Not suitable for real-time use cases. Max data processing per day: 10 TiB

Entity Relationship Diagram

Visual representation of data model relationships

                    erDiagram
	"**user_creation**"{
	source_event_type text
	source_referer text
	source_gcp_project text
	insertion_timestamp timestamp
	creation_total int
}


                  

Data Model

The logical data model

user_creation table
One record per day per application per source.
Event Type
source_event_type
text
A string representing where the user creation originates from.
Examples: MOBILE_SSO_GOOGLE, MOBILE_SSO_FACEBOOK, MOBILE_FORM, WEBSITE_SSO_GOOGLE, WEBSITE_SSO_FACEBOOK, WEBSITE_FORM
required pattern:^(MOBILE_SSO_GOOGLE|MOBILE_SSO_FACEBOOK|MOBILE_FORM|WEBSITE_SSO_GOOGLE|WEBSITE_SSO_FACEBOOK|WEBSITE_FORM)$
Host
source_referer
text
A string representing the URI of the user creation source (should not be prefixed by the scheme)
Examples: www.jeuxvideo.com, m.jeuxvideo.com, www.tudogostoso.com.br
required format:uri
GCP project ID
source_gcp_project
text
Project ID where the event originates from
Examples: prj-jv-prd-www-2828
required pattern:^prj-.*$
insertion_timestamp
timestamp
Timestamp in UTC when the batch was pushed.
Examples: 2024-09-09T08:30:00Z
required
creation_total
int
Total amount of created user.
Examples: 10
required
Quality | SQL: No negative entries
Query:
SELECT COUNT(*)
FROM user_creation
WHERE creation_total < 0;
Must Be Less Than: 0

Definitions

Domain specific definitions in the data contract

event_type
A string representing where the user creation originates from.
Event Type
event_type
text
A string representing where the user creation originates from.
Examples: MOBILE_SSO_GOOGLE, MOBILE_SSO_FACEBOOK, MOBILE_FORM, WEBSITE_SSO_GOOGLE, WEBSITE_SSO_FACEBOOK, WEBSITE_FORM
pattern:^(MOBILE_SSO_GOOGLE|MOBILE_SSO_FACEBOOK|MOBILE_FORM|WEBSITE_SSO_GOOGLE|WEBSITE_SSO_FACEBOOK|WEBSITE_FORM)$
referer
A string representing the URI of the user creation source (should not be prefixed by the scheme)
Host
referer
text
A string representing the URI of the user creation source (should not be prefixed by the scheme)
Examples: www.jeuxvideo.com, m.jeuxvideo.com, www.tudogostoso.com.br
format:uri
gcp_project
Project ID where the event originates from
GCP project ID
gcp_project
text
Project ID where the event originates from
Examples: prj-jv-prd-www-2828
pattern:^prj-.*$

Service Levels

Service levels of the data contract

Availability

Description
The BQ server is available during support hours
Percentage
99.9%

Retention

Description
Data is retained for one year
Period
P1Y

Latency

Description
Data is available within 25 hours after the order was placed
Threshold
25h
Source Timestamp field
insertion_timestamp
Processed Timestamp field
insertion_timestamp

Freshness

Description
The age of the youngest row in a table.
Threshold
25h
Timestamp field
insertion_timestamp

Frequency

Description
Data is delivered once a day
Type
batch
Interval
daily
Cron
0 0 * * *
Created at 28 Jul 2025 08:50:37 UTC with Data Contract CLI v0.10.31
dataContractSpecification: 1.2.0
id: urn:datacontract:user:creation
info:
  title: Aggregated User Creation
  version: 0.0.1
  status: active
  description: 'Aggregated user creation events since 2024-01-01.

    '
servers:
  production:
    type: bigquery
    description: One dataset per model.
    environment: prod
    project: prj-cld-prd-warehouse-1f51
    dataset: kpis_v1
terms:
  usage: 'Data can be used for reports, analytics and machine learning use cases.

    '
  limitations: 'Not suitable for real-time use cases.

    Max data processing per day: 10 TiB

    '
models:
  user_creation:
    description: One record per day per application per source.
    type: table
    fields:
      source_event_type:
        $ref: '#/definitions/event_type'
        title: Event Type
        type: text
        required: true
        description: A string representing where the user creation originates from.
        pattern: ^(MOBILE_SSO_GOOGLE|MOBILE_SSO_FACEBOOK|MOBILE_FORM|WEBSITE_SSO_GOOGLE|WEBSITE_SSO_FACEBOOK|WEBSITE_FORM)$
        examples:
        - MOBILE_SSO_GOOGLE
        - MOBILE_SSO_FACEBOOK
        - MOBILE_FORM
        - WEBSITE_SSO_GOOGLE
        - WEBSITE_SSO_FACEBOOK
        - WEBSITE_FORM
      source_referer:
        $ref: '#/definitions/referer'
        title: Host
        type: text
        format: uri
        required: true
        description: A string representing the URI of the user creation source (should
          not be prefixed by the scheme)
        examples:
        - www.jeuxvideo.com
        - m.jeuxvideo.com
        - www.tudogostoso.com.br
      source_gcp_project:
        $ref: '#/definitions/gcp_project'
        title: GCP project ID
        type: text
        required: true
        description: Project ID where the event originates from
        pattern: ^prj-.*$
        examples:
        - prj-jv-prd-www-2828
      insertion_timestamp:
        type: timestamp
        required: true
        description: Timestamp in UTC when the batch was pushed.
        examples:
        - '2024-09-09T08:30:00Z'
      creation_total:
        type: int
        required: true
        description: Total amount of created user.
        examples:
        - 10
        quality:
        - type: sql
          description: No negative entries
          query: 'SELECT COUNT(*)

            FROM user_creation

            WHERE creation_total < 0;

            '
          mustBeLessThan: 0
definitions:
  event_type:
    title: Event Type
    description: A string representing where the user creation originates from.
    type: text
    pattern: ^(MOBILE_SSO_GOOGLE|MOBILE_SSO_FACEBOOK|MOBILE_FORM|WEBSITE_SSO_GOOGLE|WEBSITE_SSO_FACEBOOK|WEBSITE_FORM)$
    examples:
    - MOBILE_SSO_GOOGLE
    - MOBILE_SSO_FACEBOOK
    - MOBILE_FORM
    - WEBSITE_SSO_GOOGLE
    - WEBSITE_SSO_FACEBOOK
    - WEBSITE_FORM
  referer:
    title: Host
    description: A string representing the URI of the user creation source (should
      not be prefixed by the scheme)
    type: text
    format: uri
    examples:
    - www.jeuxvideo.com
    - m.jeuxvideo.com
    - www.tudogostoso.com.br
  gcp_project:
    title: GCP project ID
    description: Project ID where the event originates from
    type: text
    pattern: ^prj-.*$
    examples:
    - prj-jv-prd-www-2828
servicelevels:
  availability:
    description: The BQ server is available during support hours
    percentage: 99.9%
  retention:
    description: Data is retained for one year
    period: P1Y
    unlimited: false
  latency:
    description: Data is available within 25 hours after the order was placed
    threshold: 25h
    sourceTimestampField: insertion_timestamp
    processedTimestampField: insertion_timestamp
  freshness:
    description: The age of the youngest row in a table.
    threshold: 25h
    timestampField: insertion_timestamp
  frequency:
    description: Data is delivered once a day
    type: batch
    interval: daily
    cron: 0 0 * * *